Introduction
TVox WebAPI is a set of REST APIs for TVox configuration (e.g. Power Dialer).
Endpoint for requests is constructed as follows:
https://<TVOX_HOST>/tvox
Authentication
HTTP Authentication, scheme: basic
Basic Authentication.Use HTTP Basic Authentication by providing username and password in the Authorization header.
Format:Authorization: Basic base64(username:password)API Key (SessionCookie)
- Parameter Name: JSESSIONID, in: cookie.
Authentication via session cookie.Session cookie key must be
JSESSIONIDand its path/tvox.
The value of the cookie can be recovered from the result of a successful login by credentials or access token (response field:sessionId).
By default a session has a duration of 24 hour (renewed at each request), after which the server will respond with an authentication error (status: 401). In case of this error, the session can be renewed with a new login request.
Login response includes a set-cookie header with the session cookie, automatically managed by most HTTP clients (including browsers).
- Parameter Name: JSESSIONID, in: cookie.
Addressbook Contact External
External Addressbook contacts management
Create contact
Code samples
POST %3CTVOX_HOST%3E/tvox/rest/addressbook-contact/external HTTP/1.1
Content-Type: application/json
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
Content-Length: 517
{"addressbookBackendId":"string","agentNote":"string","cap":"string","categories":["string"],"city":"string","company":"string","country":"string","customFields":[{"key":"CUSTOM_01","value":"string"}],"department":"string","district":"string","emails":[{"type":"INTERNET_WORK","value":"string"}],"id":"string","name":"string","note":"string","numbers":[{"type":"FAX","value":"string"}],"otherName":"string","role":"string","street":"string","surname":"string","vip":true,"webSites":[{"type":"WORK","value":"string"}]}
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/addressbook-contact/external",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "{\"addressbookBackendId\":\"string\",\"agentNote\":\"string\",\"cap\":\"string\",\"categories\":[\"string\"],\"city\":\"string\",\"company\":\"string\",\"country\":\"string\",\"customFields\":[{\"key\":\"CUSTOM_01\",\"value\":\"string\"}],\"department\":\"string\",\"district\":\"string\",\"emails\":[{\"type\":\"INTERNET_WORK\",\"value\":\"string\"}],\"id\":\"string\",\"name\":\"string\",\"note\":\"string\",\"numbers\":[{\"type\":\"FAX\",\"value\":\"string\"}],\"otherName\":\"string\",\"role\":\"string\",\"street\":\"string\",\"surname\":\"string\",\"vip\":true,\"webSites\":[{\"type\":\"WORK\",\"value\":\"string\"}]}",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Content-Type: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request POST \
--url https:///%3CTVOX_HOST%3E/tvox/rest/addressbook-contact/external \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID' \
--data '{"addressbookBackendId":"string","agentNote":"string","cap":"string","categories":["string"],"city":"string","company":"string","country":"string","customFields":[{"key":"CUSTOM_01","value":"string"}],"department":"string","district":"string","emails":[{"type":"INTERNET_WORK","value":"string"}],"id":"string","name":"string","note":"string","numbers":[{"type":"FAX","value":"string"}],"otherName":"string","role":"string","street":"string","surname":"string","vip":true,"webSites":[{"type":"WORK","value":"string"}]}'
HttpResponse<String> response = Unirest.post("https:///%3CTVOX_HOST%3E/tvox/rest/addressbook-contact/external")
.header("Content-Type", "application/json")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.body("{\"addressbookBackendId\":\"string\",\"agentNote\":\"string\",\"cap\":\"string\",\"categories\":[\"string\"],\"city\":\"string\",\"company\":\"string\",\"country\":\"string\",\"customFields\":[{\"key\":\"CUSTOM_01\",\"value\":\"string\"}],\"department\":\"string\",\"district\":\"string\",\"emails\":[{\"type\":\"INTERNET_WORK\",\"value\":\"string\"}],\"id\":\"string\",\"name\":\"string\",\"note\":\"string\",\"numbers\":[{\"type\":\"FAX\",\"value\":\"string\"}],\"otherName\":\"string\",\"role\":\"string\",\"street\":\"string\",\"surname\":\"string\",\"vip\":true,\"webSites\":[{\"type\":\"WORK\",\"value\":\"string\"}]}")
.asString();
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/addressbook-contact/external"
payload := strings.NewReader("{\"addressbookBackendId\":\"string\",\"agentNote\":\"string\",\"cap\":\"string\",\"categories\":[\"string\"],\"city\":\"string\",\"company\":\"string\",\"country\":\"string\",\"customFields\":[{\"key\":\"CUSTOM_01\",\"value\":\"string\"}],\"department\":\"string\",\"district\":\"string\",\"emails\":[{\"type\":\"INTERNET_WORK\",\"value\":\"string\"}],\"id\":\"string\",\"name\":\"string\",\"note\":\"string\",\"numbers\":[{\"type\":\"FAX\",\"value\":\"string\"}],\"otherName\":\"string\",\"role\":\"string\",\"street\":\"string\",\"surname\":\"string\",\"vip\":true,\"webSites\":[{\"type\":\"WORK\",\"value\":\"string\"}]}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = JSON.stringify({
"addressbookBackendId": "string",
"agentNote": "string",
"cap": "string",
"categories": [
"string"
],
"city": "string",
"company": "string",
"country": "string",
"customFields": [
{
"key": "CUSTOM_01",
"value": "string"
}
],
"department": "string",
"district": "string",
"emails": [
{
"type": "INTERNET_WORK",
"value": "string"
}
],
"id": "string",
"name": "string",
"note": "string",
"numbers": [
{
"type": "FAX",
"value": "string"
}
],
"otherName": "string",
"role": "string",
"street": "string",
"surname": "string",
"vip": true,
"webSites": [
{
"type": "WORK",
"value": "string"
}
]
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("POST", "https:///%3CTVOX_HOST%3E/tvox/rest/addressbook-contact/external");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "POST",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/addressbook-contact/external",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
addressbookBackendId: 'string',
agentNote: 'string',
cap: 'string',
categories: ['string'],
city: 'string',
company: 'string',
country: 'string',
customFields: [{key: 'CUSTOM_01', value: 'string'}],
department: 'string',
district: 'string',
emails: [{type: 'INTERNET_WORK', value: 'string'}],
id: 'string',
name: 'string',
note: 'string',
numbers: [{type: 'FAX', value: 'string'}],
otherName: 'string',
role: 'string',
street: 'string',
surname: 'string',
vip: true,
webSites: [{type: 'WORK', value: 'string'}]
}));
req.end();
import http.client
conn = http.client.HTTPSConnection("")
payload = "{\"addressbookBackendId\":\"string\",\"agentNote\":\"string\",\"cap\":\"string\",\"categories\":[\"string\"],\"city\":\"string\",\"company\":\"string\",\"country\":\"string\",\"customFields\":[{\"key\":\"CUSTOM_01\",\"value\":\"string\"}],\"department\":\"string\",\"district\":\"string\",\"emails\":[{\"type\":\"INTERNET_WORK\",\"value\":\"string\"}],\"id\":\"string\",\"name\":\"string\",\"note\":\"string\",\"numbers\":[{\"type\":\"FAX\",\"value\":\"string\"}],\"otherName\":\"string\",\"role\":\"string\",\"street\":\"string\",\"surname\":\"string\",\"vip\":true,\"webSites\":[{\"type\":\"WORK\",\"value\":\"string\"}]}"
headers = {
'Content-Type': "application/json",
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("POST", "%3CTVOX_HOST%3E/tvox/rest/addressbook-contact/external", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/addressbook-contact/external")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
request.body = "{\"addressbookBackendId\":\"string\",\"agentNote\":\"string\",\"cap\":\"string\",\"categories\":[\"string\"],\"city\":\"string\",\"company\":\"string\",\"country\":\"string\",\"customFields\":[{\"key\":\"CUSTOM_01\",\"value\":\"string\"}],\"department\":\"string\",\"district\":\"string\",\"emails\":[{\"type\":\"INTERNET_WORK\",\"value\":\"string\"}],\"id\":\"string\",\"name\":\"string\",\"note\":\"string\",\"numbers\":[{\"type\":\"FAX\",\"value\":\"string\"}],\"otherName\":\"string\",\"role\":\"string\",\"street\":\"string\",\"surname\":\"string\",\"vip\":true,\"webSites\":[{\"type\":\"WORK\",\"value\":\"string\"}]}"
response = http.request(request)
puts response.read_body
POST /rest/addressbook-contact/external
Create contact in external addressbook
Parameters
Body parameter
{
"addressbookBackendId": "string",
"agentNote": "string",
"cap": "string",
"categories": [
"string"
],
"city": "string",
"company": "string",
"country": "string",
"customFields": [
{
"key": "CUSTOM_01",
"value": "string"
}
],
"department": "string",
"district": "string",
"emails": [
{
"type": "INTERNET_WORK",
"value": "string"
}
],
"id": "string",
"name": "string",
"note": "string",
"numbers": [
{
"type": "FAX",
"value": "string"
}
],
"otherName": "string",
"role": "string",
"street": "string",
"surname": "string",
"vip": true,
"webSites": [
{
"type": "WORK",
"value": "string"
}
]
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | AddressbookContactExternal | true | Contact to create |
Responses
Example responses
default Response
{
"addressbookBackendId": "string",
"agentNote": "string",
"cap": "string",
"categories": [
"string"
],
"city": "string",
"company": "string",
"country": "string",
"customFields": [
{
"key": "CUSTOM_01",
"value": "string"
}
],
"department": "string",
"district": "string",
"emails": [
{
"type": "INTERNET_WORK",
"value": "string"
}
],
"id": "string",
"name": "string",
"note": "string",
"numbers": [
{
"type": "FAX",
"value": "string"
}
],
"otherName": "string",
"role": "string",
"street": "string",
"surname": "string",
"vip": true,
"webSites": [
{
"type": "WORK",
"value": "string"
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| 412 | Precondition Failed | Error: Object required or exceed max size. A required field is missing or empty or exceed max size | None |
| default | Default | Created contact | AddressbookContactExternal |
Update contact
Code samples
PUT %3CTVOX_HOST%3E/tvox/rest/addressbook-contact/external HTTP/1.1
Content-Type: application/json
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
Content-Length: 517
{"addressbookBackendId":"string","agentNote":"string","cap":"string","categories":["string"],"city":"string","company":"string","country":"string","customFields":[{"key":"CUSTOM_01","value":"string"}],"department":"string","district":"string","emails":[{"type":"INTERNET_WORK","value":"string"}],"id":"string","name":"string","note":"string","numbers":[{"type":"FAX","value":"string"}],"otherName":"string","role":"string","street":"string","surname":"string","vip":true,"webSites":[{"type":"WORK","value":"string"}]}
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/addressbook-contact/external",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => "{\"addressbookBackendId\":\"string\",\"agentNote\":\"string\",\"cap\":\"string\",\"categories\":[\"string\"],\"city\":\"string\",\"company\":\"string\",\"country\":\"string\",\"customFields\":[{\"key\":\"CUSTOM_01\",\"value\":\"string\"}],\"department\":\"string\",\"district\":\"string\",\"emails\":[{\"type\":\"INTERNET_WORK\",\"value\":\"string\"}],\"id\":\"string\",\"name\":\"string\",\"note\":\"string\",\"numbers\":[{\"type\":\"FAX\",\"value\":\"string\"}],\"otherName\":\"string\",\"role\":\"string\",\"street\":\"string\",\"surname\":\"string\",\"vip\":true,\"webSites\":[{\"type\":\"WORK\",\"value\":\"string\"}]}",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Content-Type: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request PUT \
--url https:///%3CTVOX_HOST%3E/tvox/rest/addressbook-contact/external \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID' \
--data '{"addressbookBackendId":"string","agentNote":"string","cap":"string","categories":["string"],"city":"string","company":"string","country":"string","customFields":[{"key":"CUSTOM_01","value":"string"}],"department":"string","district":"string","emails":[{"type":"INTERNET_WORK","value":"string"}],"id":"string","name":"string","note":"string","numbers":[{"type":"FAX","value":"string"}],"otherName":"string","role":"string","street":"string","surname":"string","vip":true,"webSites":[{"type":"WORK","value":"string"}]}'
HttpResponse<String> response = Unirest.put("https:///%3CTVOX_HOST%3E/tvox/rest/addressbook-contact/external")
.header("Content-Type", "application/json")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.body("{\"addressbookBackendId\":\"string\",\"agentNote\":\"string\",\"cap\":\"string\",\"categories\":[\"string\"],\"city\":\"string\",\"company\":\"string\",\"country\":\"string\",\"customFields\":[{\"key\":\"CUSTOM_01\",\"value\":\"string\"}],\"department\":\"string\",\"district\":\"string\",\"emails\":[{\"type\":\"INTERNET_WORK\",\"value\":\"string\"}],\"id\":\"string\",\"name\":\"string\",\"note\":\"string\",\"numbers\":[{\"type\":\"FAX\",\"value\":\"string\"}],\"otherName\":\"string\",\"role\":\"string\",\"street\":\"string\",\"surname\":\"string\",\"vip\":true,\"webSites\":[{\"type\":\"WORK\",\"value\":\"string\"}]}")
.asString();
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/addressbook-contact/external"
payload := strings.NewReader("{\"addressbookBackendId\":\"string\",\"agentNote\":\"string\",\"cap\":\"string\",\"categories\":[\"string\"],\"city\":\"string\",\"company\":\"string\",\"country\":\"string\",\"customFields\":[{\"key\":\"CUSTOM_01\",\"value\":\"string\"}],\"department\":\"string\",\"district\":\"string\",\"emails\":[{\"type\":\"INTERNET_WORK\",\"value\":\"string\"}],\"id\":\"string\",\"name\":\"string\",\"note\":\"string\",\"numbers\":[{\"type\":\"FAX\",\"value\":\"string\"}],\"otherName\":\"string\",\"role\":\"string\",\"street\":\"string\",\"surname\":\"string\",\"vip\":true,\"webSites\":[{\"type\":\"WORK\",\"value\":\"string\"}]}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = JSON.stringify({
"addressbookBackendId": "string",
"agentNote": "string",
"cap": "string",
"categories": [
"string"
],
"city": "string",
"company": "string",
"country": "string",
"customFields": [
{
"key": "CUSTOM_01",
"value": "string"
}
],
"department": "string",
"district": "string",
"emails": [
{
"type": "INTERNET_WORK",
"value": "string"
}
],
"id": "string",
"name": "string",
"note": "string",
"numbers": [
{
"type": "FAX",
"value": "string"
}
],
"otherName": "string",
"role": "string",
"street": "string",
"surname": "string",
"vip": true,
"webSites": [
{
"type": "WORK",
"value": "string"
}
]
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("PUT", "https:///%3CTVOX_HOST%3E/tvox/rest/addressbook-contact/external");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "PUT",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/addressbook-contact/external",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
addressbookBackendId: 'string',
agentNote: 'string',
cap: 'string',
categories: ['string'],
city: 'string',
company: 'string',
country: 'string',
customFields: [{key: 'CUSTOM_01', value: 'string'}],
department: 'string',
district: 'string',
emails: [{type: 'INTERNET_WORK', value: 'string'}],
id: 'string',
name: 'string',
note: 'string',
numbers: [{type: 'FAX', value: 'string'}],
otherName: 'string',
role: 'string',
street: 'string',
surname: 'string',
vip: true,
webSites: [{type: 'WORK', value: 'string'}]
}));
req.end();
import http.client
conn = http.client.HTTPSConnection("")
payload = "{\"addressbookBackendId\":\"string\",\"agentNote\":\"string\",\"cap\":\"string\",\"categories\":[\"string\"],\"city\":\"string\",\"company\":\"string\",\"country\":\"string\",\"customFields\":[{\"key\":\"CUSTOM_01\",\"value\":\"string\"}],\"department\":\"string\",\"district\":\"string\",\"emails\":[{\"type\":\"INTERNET_WORK\",\"value\":\"string\"}],\"id\":\"string\",\"name\":\"string\",\"note\":\"string\",\"numbers\":[{\"type\":\"FAX\",\"value\":\"string\"}],\"otherName\":\"string\",\"role\":\"string\",\"street\":\"string\",\"surname\":\"string\",\"vip\":true,\"webSites\":[{\"type\":\"WORK\",\"value\":\"string\"}]}"
headers = {
'Content-Type': "application/json",
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("PUT", "%3CTVOX_HOST%3E/tvox/rest/addressbook-contact/external", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/addressbook-contact/external")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
request.body = "{\"addressbookBackendId\":\"string\",\"agentNote\":\"string\",\"cap\":\"string\",\"categories\":[\"string\"],\"city\":\"string\",\"company\":\"string\",\"country\":\"string\",\"customFields\":[{\"key\":\"CUSTOM_01\",\"value\":\"string\"}],\"department\":\"string\",\"district\":\"string\",\"emails\":[{\"type\":\"INTERNET_WORK\",\"value\":\"string\"}],\"id\":\"string\",\"name\":\"string\",\"note\":\"string\",\"numbers\":[{\"type\":\"FAX\",\"value\":\"string\"}],\"otherName\":\"string\",\"role\":\"string\",\"street\":\"string\",\"surname\":\"string\",\"vip\":true,\"webSites\":[{\"type\":\"WORK\",\"value\":\"string\"}]}"
response = http.request(request)
puts response.read_body
PUT /rest/addressbook-contact/external
Update contact in external addressbook
Parameters
Body parameter
{
"addressbookBackendId": "string",
"agentNote": "string",
"cap": "string",
"categories": [
"string"
],
"city": "string",
"company": "string",
"country": "string",
"customFields": [
{
"key": "CUSTOM_01",
"value": "string"
}
],
"department": "string",
"district": "string",
"emails": [
{
"type": "INTERNET_WORK",
"value": "string"
}
],
"id": "string",
"name": "string",
"note": "string",
"numbers": [
{
"type": "FAX",
"value": "string"
}
],
"otherName": "string",
"role": "string",
"street": "string",
"surname": "string",
"vip": true,
"webSites": [
{
"type": "WORK",
"value": "string"
}
]
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | AddressbookContactExternal | true | Contact to update |
Responses
Example responses
default Response
{
"addressbookBackendId": "string",
"agentNote": "string",
"cap": "string",
"categories": [
"string"
],
"city": "string",
"company": "string",
"country": "string",
"customFields": [
{
"key": "CUSTOM_01",
"value": "string"
}
],
"department": "string",
"district": "string",
"emails": [
{
"type": "INTERNET_WORK",
"value": "string"
}
],
"id": "string",
"name": "string",
"note": "string",
"numbers": [
{
"type": "FAX",
"value": "string"
}
],
"otherName": "string",
"role": "string",
"street": "string",
"surname": "string",
"vip": true,
"webSites": [
{
"type": "WORK",
"value": "string"
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| 404 | Not Found | Error: Object was not found. | GenericObjectWasNotFoundException |
| 412 | Precondition Failed | Error: Object required or exceed max size. A required field is missing or empty or exceed max size | None |
| default | Default | Updated contact | AddressbookContactExternal |
Delete contact
Code samples
DELETE %3CTVOX_HOST%3E/tvox/rest/addressbook-contact/external/string HTTP/1.1
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/addressbook-contact/external/string",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request DELETE \
--url https:///%3CTVOX_HOST%3E/tvox/rest/addressbook-contact/external/string \
--header 'Accept: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID'
HttpResponse<String> response = Unirest.delete("https:///%3CTVOX_HOST%3E/tvox/rest/addressbook-contact/external/string")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.asString();
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/addressbook-contact/external/string"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("DELETE", "https:///%3CTVOX_HOST%3E/tvox/rest/addressbook-contact/external/string");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "DELETE",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/addressbook-contact/external/string",
"headers": {
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
import http.client
conn = http.client.HTTPSConnection("")
headers = {
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("DELETE", "%3CTVOX_HOST%3E/tvox/rest/addressbook-contact/external/string", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/addressbook-contact/external/string")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Delete.new(url)
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
response = http.request(request)
puts response.read_body
DELETE /rest/addressbook-contact/external/{id}
Delete contact from external addressbook
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | Contact id |
Responses
Example responses
default Response
true
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| 404 | Not Found | Error: Object was not found. | GenericObjectWasNotFoundException |
| 412 | Precondition Failed | Error: Object required. A required field is missing or empty | GenericObjectRequiredException |
| default | Default | Contact deleted | boolean |
Read contact
Code samples
GET %3CTVOX_HOST%3E/tvox/rest/addressbook-contact/external/string HTTP/1.1
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/addressbook-contact/external/string",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request GET \
--url https:///%3CTVOX_HOST%3E/tvox/rest/addressbook-contact/external/string \
--header 'Accept: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID'
HttpResponse<String> response = Unirest.get("https:///%3CTVOX_HOST%3E/tvox/rest/addressbook-contact/external/string")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.asString();
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/addressbook-contact/external/string"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("GET", "https:///%3CTVOX_HOST%3E/tvox/rest/addressbook-contact/external/string");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "GET",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/addressbook-contact/external/string",
"headers": {
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
import http.client
conn = http.client.HTTPSConnection("")
headers = {
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("GET", "%3CTVOX_HOST%3E/tvox/rest/addressbook-contact/external/string", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/addressbook-contact/external/string")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
response = http.request(request)
puts response.read_body
GET /rest/addressbook-contact/external/{id}
Read contact from external addressbook
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | Contact id |
Responses
Example responses
default Response
{
"addressbookBackendId": "string",
"agentNote": "string",
"cap": "string",
"categories": [
"string"
],
"city": "string",
"company": "string",
"country": "string",
"customFields": [
{
"key": "CUSTOM_01",
"value": "string"
}
],
"department": "string",
"district": "string",
"emails": [
{
"type": "INTERNET_WORK",
"value": "string"
}
],
"id": "string",
"name": "string",
"note": "string",
"numbers": [
{
"type": "FAX",
"value": "string"
}
],
"otherName": "string",
"role": "string",
"street": "string",
"surname": "string",
"vip": true,
"webSites": [
{
"type": "WORK",
"value": "string"
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| 404 | Not Found | Error: Object was not found. | GenericObjectWasNotFoundException |
| 412 | Precondition Failed | Error: Object required. A required field is missing or empty | GenericObjectRequiredException |
| default | Default | Read contact | AddressbookContactExternal |
Auth
Authentication, version and user session management
Check if current user session is still valid
Code samples
GET %3CTVOX_HOST%3E/tvox/rest/auth/isValidSession HTTP/1.1
Accept: application/json
Host:
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/auth/isValidSession",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Accept: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request GET \
--url https:///%3CTVOX_HOST%3E/tvox/rest/auth/isValidSession \
--header 'Accept: application/json'
HttpResponse<String> response = Unirest.get("https:///%3CTVOX_HOST%3E/tvox/rest/auth/isValidSession")
.header("Accept", "application/json")
.asString();
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/auth/isValidSession"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Accept", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("GET", "https:///%3CTVOX_HOST%3E/tvox/rest/auth/isValidSession");
xhr.setRequestHeader("Accept", "application/json");
xhr.send(data);
const http = require("https");
const options = {
"method": "GET",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/auth/isValidSession",
"headers": {
"Accept": "application/json"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
import http.client
conn = http.client.HTTPSConnection("")
headers = { 'Accept': "application/json" }
conn.request("GET", "%3CTVOX_HOST%3E/tvox/rest/auth/isValidSession", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/auth/isValidSession")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/json'
response = http.request(request)
puts response.read_body
GET /rest/auth/isValidSession
Check if the session is still valid
Responses
Example responses
default Response
true
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| default | Default | Current user session valid | boolean |
Login by user id and password
Code samples
POST %3CTVOX_HOST%3E/tvox/rest/auth/login HTTP/1.1
Content-Type: application/json
Accept: application/json
Host:
Content-Length: 60
{"password":"string","username":"string","version":"string"}
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/auth/login",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "{\"password\":\"string\",\"username\":\"string\",\"version\":\"string\"}",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request POST \
--url https:///%3CTVOX_HOST%3E/tvox/rest/auth/login \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{"password":"string","username":"string","version":"string"}'
HttpResponse<String> response = Unirest.post("https:///%3CTVOX_HOST%3E/tvox/rest/auth/login")
.header("Content-Type", "application/json")
.header("Accept", "application/json")
.body("{\"password\":\"string\",\"username\":\"string\",\"version\":\"string\"}")
.asString();
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/auth/login"
payload := strings.NewReader("{\"password\":\"string\",\"username\":\"string\",\"version\":\"string\"}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = JSON.stringify({
"password": "string",
"username": "string",
"version": "string"
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("POST", "https:///%3CTVOX_HOST%3E/tvox/rest/auth/login");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Accept", "application/json");
xhr.send(data);
const http = require("https");
const options = {
"method": "POST",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/auth/login",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({password: 'string', username: 'string', version: 'string'}));
req.end();
import http.client
conn = http.client.HTTPSConnection("")
payload = "{\"password\":\"string\",\"username\":\"string\",\"version\":\"string\"}"
headers = {
'Content-Type': "application/json",
'Accept': "application/json"
}
conn.request("POST", "%3CTVOX_HOST%3E/tvox/rest/auth/login", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/auth/login")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request["Accept"] = 'application/json'
request.body = "{\"password\":\"string\",\"username\":\"string\",\"version\":\"string\"}"
response = http.request(request)
puts response.read_body
POST /rest/auth/login
Execute the login by user id and password
Parameters
Body parameter
{
"password": "string",
"username": "string",
"version": "string"
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | LoginRequest | true | Login with credentials request |
Responses
Example responses
default Response
{
"accessToken": "string",
"anonymous": true,
"chatAuthToken": "string",
"chatUri": "string",
"chatUserId": "string",
"customProperties": {
"property1": {},
"property2": {}
},
"isCloudPlatform": true,
"language": "IT",
"logged": true,
"name": "string",
"profileRoles": [
"string"
],
"publicUsername": "string",
"pwdChangeable": true,
"sessionId": "string",
"status": "UNKNOWN",
"supportAuthToken": "string",
"surname": "string",
"userPermissions": [
"SUPERUSER"
],
"username": "string"
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error:
|
None |
| 403 | Forbidden | Error: Password expired or insecure. | None |
| default | Default | Logged user profile | LoginProfile |
Login by access token
Code samples
POST %3CTVOX_HOST%3E/tvox/rest/auth/loginByAccessToken HTTP/1.1
Content-Type: application/json
Accept: application/json
Host:
Content-Length: 43
{"accessToken":"string","version":"string"}
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/auth/loginByAccessToken",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "{\"accessToken\":\"string\",\"version\":\"string\"}",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request POST \
--url https:///%3CTVOX_HOST%3E/tvox/rest/auth/loginByAccessToken \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{"accessToken":"string","version":"string"}'
HttpResponse<String> response = Unirest.post("https:///%3CTVOX_HOST%3E/tvox/rest/auth/loginByAccessToken")
.header("Content-Type", "application/json")
.header("Accept", "application/json")
.body("{\"accessToken\":\"string\",\"version\":\"string\"}")
.asString();
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/auth/loginByAccessToken"
payload := strings.NewReader("{\"accessToken\":\"string\",\"version\":\"string\"}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = JSON.stringify({
"accessToken": "string",
"version": "string"
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("POST", "https:///%3CTVOX_HOST%3E/tvox/rest/auth/loginByAccessToken");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Accept", "application/json");
xhr.send(data);
const http = require("https");
const options = {
"method": "POST",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/auth/loginByAccessToken",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({accessToken: 'string', version: 'string'}));
req.end();
import http.client
conn = http.client.HTTPSConnection("")
payload = "{\"accessToken\":\"string\",\"version\":\"string\"}"
headers = {
'Content-Type': "application/json",
'Accept': "application/json"
}
conn.request("POST", "%3CTVOX_HOST%3E/tvox/rest/auth/loginByAccessToken", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/auth/loginByAccessToken")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request["Accept"] = 'application/json'
request.body = "{\"accessToken\":\"string\",\"version\":\"string\"}"
response = http.request(request)
puts response.read_body
POST /rest/auth/loginByAccessToken
Execute the login by access token
Parameters
Body parameter
{
"accessToken": "string",
"version": "string"
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | LoginByAccessTokenRequest | true | Login with access token request |
Responses
Example responses
default Response
{
"accessToken": "string",
"anonymous": true,
"chatAuthToken": "string",
"chatUri": "string",
"chatUserId": "string",
"customProperties": {
"property1": {},
"property2": {}
},
"isCloudPlatform": true,
"language": "IT",
"logged": true,
"name": "string",
"profileRoles": [
"string"
],
"publicUsername": "string",
"pwdChangeable": true,
"sessionId": "string",
"status": "UNKNOWN",
"supportAuthToken": "string",
"surname": "string",
"userPermissions": [
"SUPERUSER"
],
"username": "string"
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error:
|
None |
| 403 | Forbidden | Error: Password expired or insecure. | None |
| default | Default | Logged user profile | LoginProfile |
Logout from current user session
Code samples
GET %3CTVOX_HOST%3E/tvox/rest/auth/logout HTTP/1.1
Accept: application/json
Host:
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/auth/logout",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Accept: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request GET \
--url https:///%3CTVOX_HOST%3E/tvox/rest/auth/logout \
--header 'Accept: application/json'
HttpResponse<String> response = Unirest.get("https:///%3CTVOX_HOST%3E/tvox/rest/auth/logout")
.header("Accept", "application/json")
.asString();
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/auth/logout"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Accept", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("GET", "https:///%3CTVOX_HOST%3E/tvox/rest/auth/logout");
xhr.setRequestHeader("Accept", "application/json");
xhr.send(data);
const http = require("https");
const options = {
"method": "GET",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/auth/logout",
"headers": {
"Accept": "application/json"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
import http.client
conn = http.client.HTTPSConnection("")
headers = { 'Accept': "application/json" }
conn.request("GET", "%3CTVOX_HOST%3E/tvox/rest/auth/logout", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/auth/logout")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/json'
response = http.request(request)
puts response.read_body
GET /rest/auth/logout
Responses
Example responses
default Response
true
| Status | Meaning | Description | Schema |
|---|---|---|---|
| default | Default | User logout | boolean |
Retrieve TVox and API version
Code samples
GET %3CTVOX_HOST%3E/tvox/rest/auth/version HTTP/1.1
Accept: application/json
Host:
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/auth/version",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Accept: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request GET \
--url https:///%3CTVOX_HOST%3E/tvox/rest/auth/version \
--header 'Accept: application/json'
HttpResponse<String> response = Unirest.get("https:///%3CTVOX_HOST%3E/tvox/rest/auth/version")
.header("Accept", "application/json")
.asString();
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/auth/version"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Accept", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("GET", "https:///%3CTVOX_HOST%3E/tvox/rest/auth/version");
xhr.setRequestHeader("Accept", "application/json");
xhr.send(data);
const http = require("https");
const options = {
"method": "GET",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/auth/version",
"headers": {
"Accept": "application/json"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
import http.client
conn = http.client.HTTPSConnection("")
headers = { 'Accept': "application/json" }
conn.request("GET", "%3CTVOX_HOST%3E/tvox/rest/auth/version", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/auth/version")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/json'
response = http.request(request)
puts response.read_body
GET /rest/auth/version
Responses
Example responses
default Response
{
"tvoxVersion": "string",
"webapiVersion": "string"
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| default | Default | TVox and API version | APIVersion |
Chat
Chat history
List chat session messages
Code samples
GET %3CTVOX_HOST%3E/tvox/rest/chat/history/session/string HTTP/1.1
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/chat/history/session/string",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request GET \
--url https:///%3CTVOX_HOST%3E/tvox/rest/chat/history/session/string \
--header 'Accept: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID'
HttpResponse<String> response = Unirest.get("https:///%3CTVOX_HOST%3E/tvox/rest/chat/history/session/string")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.asString();
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/chat/history/session/string"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("GET", "https:///%3CTVOX_HOST%3E/tvox/rest/chat/history/session/string");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "GET",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/chat/history/session/string",
"headers": {
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
import http.client
conn = http.client.HTTPSConnection("")
headers = {
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("GET", "%3CTVOX_HOST%3E/tvox/rest/chat/history/session/string", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/chat/history/session/string")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
response = http.request(request)
puts response.read_body
GET /rest/chat/history/session/{id}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | Chat session id |
| pageNumber | query | integer(int32) | false | Page number (must be greater than 0) |
| pageSize | query | integer(int32) | false | Page size (must be greater than 0) |
Responses
Example responses
default Response
{
"result": [
{
"agent": {
"displayName": "string",
"name": "string",
"surname": "string",
"type": "USER",
"uid": "string",
"username": "string",
"value": "string"
},
"attachment": {
"file": "string",
"fileName": "string",
"mimeType": "string"
},
"channelType": "WIDGET",
"customer": {
"displayName": "string",
"name": "string",
"surname": "string",
"type": "USER",
"uid": "string",
"username": "string",
"value": "string"
},
"id": "string",
"insertTime": "2019-08-24T14:15:22Z",
"message": "string",
"messageId": "string",
"messageType": "OPEN_SESSION",
"readTime": "2019-08-24T14:15:22Z",
"receivedTime": "2019-08-24T14:15:22Z",
"sender": "AGENT",
"service": {
"bpmProcessId": 0,
"code": "string",
"exten": "string",
"name": "string",
"registration": "DISABLED",
"type": "IVR",
"version": 0
},
"sessionId": "string",
"updateTime": "2019-08-24T14:15:22Z"
}
],
"tot": 0
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| 404 | Not Found | Error: Object was not found. | GenericObjectWasNotFoundException |
| 412 | Precondition Failed | Error: Object required. A required field is missing or empty | GenericObjectRequiredException |
| default | Default | Chat session messages | SearchResultChatHistoryMessage |
Phone channel - Call
Phone channel - Call management
Dial number
Code samples
POST %3CTVOX_HOST%3E/tvox/rest/phone/call/dial?number=string HTTP/1.1
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/phone/call/dial?number=string",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request POST \
--url 'https:///%3CTVOX_HOST%3E/tvox/rest/phone/call/dial?number=string' \
--header 'Accept: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID'
HttpResponse<String> response = Unirest.post("https:///%3CTVOX_HOST%3E/tvox/rest/phone/call/dial?number=string")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.asString();
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/phone/call/dial?number=string"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("POST", "https:///%3CTVOX_HOST%3E/tvox/rest/phone/call/dial?number=string");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "POST",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/phone/call/dial?number=string",
"headers": {
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
import http.client
conn = http.client.HTTPSConnection("")
headers = {
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("POST", "%3CTVOX_HOST%3E/tvox/rest/phone/call/dial?number=string", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/phone/call/dial?number=string")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Post.new(url)
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
response = http.request(request)
puts response.read_body
POST /rest/phone/call/dial
Dial number to call, record the call, passing additional information (access code, service for call tagging, extra data, etc.)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| username | query | string | false | User id of the user making the call. If not specified, the currently logged in user is used |
| dialerNumber | query | string | false | Number of the user making the call |
| number | query | string | true | Number to call |
| accessCode | query | string | false | Access code to use for the call |
| callData | query | string | false | Extra data to pass on the call |
| recordCall | query | boolean | false | Record call |
| recordOnConnect | query | boolean | false | Record call on connect event |
| recordAuto | query | boolean | false | Automatic recording on the call enabled |
| recFileName | query | string | false | Recording file name |
| recData | query | string | false | Recording data |
| returnCallId | query | boolean | false | Return the call id |
| serviceCode | query | string | false | Service code to be used for call tagging |
| extenType | query | string | false | Exten type of the user making the call |
| exten | query | string | false | Exten number of the user making the call |
Enumerated Values
| Parameter | Value |
|---|---|
| extenType | MCS_SIP |
| extenType | MCS_APP |
| extenType | MCS_APP_WEBRTC |
| extenType | SIP |
| extenType | EXTERNAL |
| extenType | WEBRTC |
Responses
Example responses
default Response
"string"
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| 406 | Not Acceptable | Error: Invalid argument. | InvalidArgumentException |
| 412 | Precondition Failed | Error:
|
None |
| 502 | Bad Gateway | Error: Dial number error. Dial number generic server error. | DialNumberGenericException |
| 580 | Unknown | Error: Recording call error. Recording call request error | RecordingException |
| default | Default | Call id (if "returnCallId" is true) | string |
Hangup call
Code samples
POST %3CTVOX_HOST%3E/tvox/rest/phone/call/hangup HTTP/1.1
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/phone/call/hangup",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request POST \
--url https:///%3CTVOX_HOST%3E/tvox/rest/phone/call/hangup \
--header 'Accept: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID'
HttpResponse<String> response = Unirest.post("https:///%3CTVOX_HOST%3E/tvox/rest/phone/call/hangup")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.asString();
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/phone/call/hangup"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("POST", "https:///%3CTVOX_HOST%3E/tvox/rest/phone/call/hangup");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "POST",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/phone/call/hangup",
"headers": {
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
import http.client
conn = http.client.HTTPSConnection("")
headers = {
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("POST", "%3CTVOX_HOST%3E/tvox/rest/phone/call/hangup", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/phone/call/hangup")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Post.new(url)
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
response = http.request(request)
puts response.read_body
POST /rest/phone/call/hangup
Hangup call in progess by call id, user id or exten number of the user making the call.
If none of call id, user id or exten is specified, the currently logged in user is used.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| callId | query | string | false | Call id |
| username | query | string | false | User id of the user making the call |
| exten | query | string | false | Exten number of the user making the call |
Responses
Example responses
default Response
true
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| 404 | Not Found | Error: Object was not found. | GenericObjectWasNotFoundException |
| 412 | Precondition Failed | Error: Object required. A required field is missing or empty | GenericObjectRequiredException |
| default | Default | Call was hung up | boolean |
Start call recording
Code samples
POST %3CTVOX_HOST%3E/tvox/rest/phone/call/rec/start/string/string HTTP/1.1
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/phone/call/rec/start/string/string",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request POST \
--url https:///%3CTVOX_HOST%3E/tvox/rest/phone/call/rec/start/string/string \
--header 'Accept: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID'
HttpResponse<String> response = Unirest.post("https:///%3CTVOX_HOST%3E/tvox/rest/phone/call/rec/start/string/string")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.asString();
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/phone/call/rec/start/string/string"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("POST", "https:///%3CTVOX_HOST%3E/tvox/rest/phone/call/rec/start/string/string");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "POST",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/phone/call/rec/start/string/string",
"headers": {
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
import http.client
conn = http.client.HTTPSConnection("")
headers = {
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("POST", "%3CTVOX_HOST%3E/tvox/rest/phone/call/rec/start/string/string", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/phone/call/rec/start/string/string")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Post.new(url)
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
response = http.request(request)
puts response.read_body
POST /rest/phone/call/rec/start/{userId}/{callId}
Start call recording
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| userId | path | string | true | User id of the user you want to record the call for |
| callId | path | string | true | Call id to be recorded |
| recFileName | query | string | false | Recording file name |
| recordOnConnect | query | boolean | false | Record call on connect event |
Responses
Example responses
default Response
"string"
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| 404 | Not Found | Error: User was not found. | GenericObjectWasNotFoundException |
| 412 | Precondition Failed | Error: Object required. A required field is missing or empty | GenericObjectRequiredException |
| 580 | Unknown | Error: Recording call error. Recording call request error | RecordingException |
| default | Default | Recording file name | string |
Stop call recording
Code samples
POST %3CTVOX_HOST%3E/tvox/rest/phone/call/rec/stop/string/string HTTP/1.1
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/phone/call/rec/stop/string/string",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request POST \
--url https:///%3CTVOX_HOST%3E/tvox/rest/phone/call/rec/stop/string/string \
--header 'Accept: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID'
HttpResponse<String> response = Unirest.post("https:///%3CTVOX_HOST%3E/tvox/rest/phone/call/rec/stop/string/string")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.asString();
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/phone/call/rec/stop/string/string"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("POST", "https:///%3CTVOX_HOST%3E/tvox/rest/phone/call/rec/stop/string/string");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "POST",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/phone/call/rec/stop/string/string",
"headers": {
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
import http.client
conn = http.client.HTTPSConnection("")
headers = {
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("POST", "%3CTVOX_HOST%3E/tvox/rest/phone/call/rec/stop/string/string", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/phone/call/rec/stop/string/string")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Post.new(url)
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
response = http.request(request)
puts response.read_body
POST /rest/phone/call/rec/stop/{userId}/{callId}
Stop call recording
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| userId | path | string | true | User id of the user recording the call |
| callId | path | string | true | Call id being recorded |
Responses
Example responses
default Response
true
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| 404 | Not Found | Error: User was not found. | GenericObjectWasNotFoundException |
| 412 | Precondition Failed | Error: Object required. A required field is missing or empty | GenericObjectRequiredException |
| 580 | Unknown | Error: Recording call error. Recording call request error | RecordingException |
| default | Default | Recording stopped | boolean |
Get service calls on user
Code samples
GET %3CTVOX_HOST%3E/tvox/rest/phone/call/service-calls-on-user/string HTTP/1.1
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/phone/call/service-calls-on-user/string",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request GET \
--url https:///%3CTVOX_HOST%3E/tvox/rest/phone/call/service-calls-on-user/string \
--header 'Accept: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID'
HttpResponse<String> response = Unirest.get("https:///%3CTVOX_HOST%3E/tvox/rest/phone/call/service-calls-on-user/string")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.asString();
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/phone/call/service-calls-on-user/string"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("GET", "https:///%3CTVOX_HOST%3E/tvox/rest/phone/call/service-calls-on-user/string");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "GET",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/phone/call/service-calls-on-user/string",
"headers": {
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
import http.client
conn = http.client.HTTPSConnection("")
headers = {
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("GET", "%3CTVOX_HOST%3E/tvox/rest/phone/call/service-calls-on-user/string", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/phone/call/service-calls-on-user/string")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
response = http.request(request)
puts response.read_body
GET /rest/phone/call/service-calls-on-user/{userId}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| userId | path | string | true | User id of the user |
| onlyAnswered | query | boolean | false | Filter only answered calls (default: false) |
Responses
Example responses
default Response
{
"answer": "2019-08-24T14:15:22Z",
"callData": "string",
"callInfo": {
"property1": "string",
"property2": "string"
},
"clid": "string",
"dnis": "string",
"end": "2019-08-24T14:15:22Z",
"recFileName": "string",
"service": "string",
"sipCallId": "string",
"skillset": "string",
"start": "2019-08-24T14:15:22Z",
"uniqueId": "string"
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| 412 | Precondition Failed | Error: Object required. A required field is missing or empty | GenericObjectRequiredException |
| default | Default | List of service calls | [ServiceCallDetailRecord] |
Power Dialer
Power Dialer campaign management
Create campaign
Code samples
POST %3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign HTTP/1.1
Content-Type: application/json
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
Content-Length: 325
{"abilitazioneId":0,"busyChannels":400,"busyChannelsType":"PRESENT","enabled":true,"endDate":"2019-08-24T14:15:22Z","id":0,"lists":[{"enabled":true,"listId":0,"priority":0}],"name":"string","priority":1,"reservedChannels":100,"serviceCode":"string","startDate":"2019-08-24T14:15:22Z","type":"CALL","usersToNotify":["string"]}
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "{\"abilitazioneId\":0,\"busyChannels\":400,\"busyChannelsType\":\"PRESENT\",\"enabled\":true,\"endDate\":\"2019-08-24T14:15:22Z\",\"id\":0,\"lists\":[{\"enabled\":true,\"listId\":0,\"priority\":0}],\"name\":\"string\",\"priority\":1,\"reservedChannels\":100,\"serviceCode\":\"string\",\"startDate\":\"2019-08-24T14:15:22Z\",\"type\":\"CALL\",\"usersToNotify\":[\"string\"]}",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Content-Type: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request POST \
--url https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID' \
--data '{"abilitazioneId":0,"busyChannels":400,"busyChannelsType":"PRESENT","enabled":true,"endDate":"2019-08-24T14:15:22Z","id":0,"lists":[{"enabled":true,"listId":0,"priority":0}],"name":"string","priority":1,"reservedChannels":100,"serviceCode":"string","startDate":"2019-08-24T14:15:22Z","type":"CALL","usersToNotify":["string"]}'
HttpResponse<String> response = Unirest.post("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign")
.header("Content-Type", "application/json")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.body("{\"abilitazioneId\":0,\"busyChannels\":400,\"busyChannelsType\":\"PRESENT\",\"enabled\":true,\"endDate\":\"2019-08-24T14:15:22Z\",\"id\":0,\"lists\":[{\"enabled\":true,\"listId\":0,\"priority\":0}],\"name\":\"string\",\"priority\":1,\"reservedChannels\":100,\"serviceCode\":\"string\",\"startDate\":\"2019-08-24T14:15:22Z\",\"type\":\"CALL\",\"usersToNotify\":[\"string\"]}")
.asString();
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign"
payload := strings.NewReader("{\"abilitazioneId\":0,\"busyChannels\":400,\"busyChannelsType\":\"PRESENT\",\"enabled\":true,\"endDate\":\"2019-08-24T14:15:22Z\",\"id\":0,\"lists\":[{\"enabled\":true,\"listId\":0,\"priority\":0}],\"name\":\"string\",\"priority\":1,\"reservedChannels\":100,\"serviceCode\":\"string\",\"startDate\":\"2019-08-24T14:15:22Z\",\"type\":\"CALL\",\"usersToNotify\":[\"string\"]}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = JSON.stringify({
"abilitazioneId": 0,
"busyChannels": 400,
"busyChannelsType": "PRESENT",
"enabled": true,
"endDate": "2019-08-24T14:15:22Z",
"id": 0,
"lists": [
{
"enabled": true,
"listId": 0,
"priority": 0
}
],
"name": "string",
"priority": 1,
"reservedChannels": 100,
"serviceCode": "string",
"startDate": "2019-08-24T14:15:22Z",
"type": "CALL",
"usersToNotify": [
"string"
]
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("POST", "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "POST",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
abilitazioneId: 0,
busyChannels: 400,
busyChannelsType: 'PRESENT',
enabled: true,
endDate: '2019-08-24T14:15:22Z',
id: 0,
lists: [{enabled: true, listId: 0, priority: 0}],
name: 'string',
priority: 1,
reservedChannels: 100,
serviceCode: 'string',
startDate: '2019-08-24T14:15:22Z',
type: 'CALL',
usersToNotify: ['string']
}));
req.end();
import http.client
conn = http.client.HTTPSConnection("")
payload = "{\"abilitazioneId\":0,\"busyChannels\":400,\"busyChannelsType\":\"PRESENT\",\"enabled\":true,\"endDate\":\"2019-08-24T14:15:22Z\",\"id\":0,\"lists\":[{\"enabled\":true,\"listId\":0,\"priority\":0}],\"name\":\"string\",\"priority\":1,\"reservedChannels\":100,\"serviceCode\":\"string\",\"startDate\":\"2019-08-24T14:15:22Z\",\"type\":\"CALL\",\"usersToNotify\":[\"string\"]}"
headers = {
'Content-Type': "application/json",
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("POST", "%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
request.body = "{\"abilitazioneId\":0,\"busyChannels\":400,\"busyChannelsType\":\"PRESENT\",\"enabled\":true,\"endDate\":\"2019-08-24T14:15:22Z\",\"id\":0,\"lists\":[{\"enabled\":true,\"listId\":0,\"priority\":0}],\"name\":\"string\",\"priority\":1,\"reservedChannels\":100,\"serviceCode\":\"string\",\"startDate\":\"2019-08-24T14:15:22Z\",\"type\":\"CALL\",\"usersToNotify\":[\"string\"]}"
response = http.request(request)
puts response.read_body
POST /rest/powerdialer/campaign
Parameters
Body parameter
{
"abilitazioneId": 0,
"busyChannels": 400,
"busyChannelsType": "PRESENT",
"enabled": true,
"endDate": "2019-08-24T14:15:22Z",
"id": 0,
"lists": [
{
"enabled": true,
"listId": 0,
"priority": 0
}
],
"name": "string",
"priority": 1,
"reservedChannels": 100,
"serviceCode": "string",
"startDate": "2019-08-24T14:15:22Z",
"type": "CALL",
"usersToNotify": [
"string"
]
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | PDCampaign | true | Campaign to create |
Responses
Example responses
default Response
{
"abilitazioneId": 0,
"busyChannels": 400,
"busyChannelsType": "PRESENT",
"enabled": true,
"endDate": "2019-08-24T14:15:22Z",
"id": 0,
"lists": [
{
"enabled": true,
"listId": 0,
"priority": 0
}
],
"name": "string",
"priority": 1,
"reservedChannels": 100,
"serviceCode": "string",
"startDate": "2019-08-24T14:15:22Z",
"type": "CALL",
"usersToNotify": [
"string"
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| 404 | Not Found | Error: Object was not found. | GenericObjectWasNotFoundException |
| 406 | Not Acceptable | Error: Invalid argument. | InvalidArgumentException |
| 409 | Conflict | Error: Object already exists. | GenericObjectExistsException |
| 412 | Precondition Failed | Error: Object required. A required field is missing or empty | GenericObjectRequiredException |
| default | Default | Created campaign | PDCampaign |
Update campaign
Code samples
PUT %3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign HTTP/1.1
Content-Type: application/json
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
Content-Length: 325
{"abilitazioneId":0,"busyChannels":400,"busyChannelsType":"PRESENT","enabled":true,"endDate":"2019-08-24T14:15:22Z","id":0,"lists":[{"enabled":true,"listId":0,"priority":0}],"name":"string","priority":1,"reservedChannels":100,"serviceCode":"string","startDate":"2019-08-24T14:15:22Z","type":"CALL","usersToNotify":["string"]}
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => "{\"abilitazioneId\":0,\"busyChannels\":400,\"busyChannelsType\":\"PRESENT\",\"enabled\":true,\"endDate\":\"2019-08-24T14:15:22Z\",\"id\":0,\"lists\":[{\"enabled\":true,\"listId\":0,\"priority\":0}],\"name\":\"string\",\"priority\":1,\"reservedChannels\":100,\"serviceCode\":\"string\",\"startDate\":\"2019-08-24T14:15:22Z\",\"type\":\"CALL\",\"usersToNotify\":[\"string\"]}",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Content-Type: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request PUT \
--url https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID' \
--data '{"abilitazioneId":0,"busyChannels":400,"busyChannelsType":"PRESENT","enabled":true,"endDate":"2019-08-24T14:15:22Z","id":0,"lists":[{"enabled":true,"listId":0,"priority":0}],"name":"string","priority":1,"reservedChannels":100,"serviceCode":"string","startDate":"2019-08-24T14:15:22Z","type":"CALL","usersToNotify":["string"]}'
HttpResponse<String> response = Unirest.put("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign")
.header("Content-Type", "application/json")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.body("{\"abilitazioneId\":0,\"busyChannels\":400,\"busyChannelsType\":\"PRESENT\",\"enabled\":true,\"endDate\":\"2019-08-24T14:15:22Z\",\"id\":0,\"lists\":[{\"enabled\":true,\"listId\":0,\"priority\":0}],\"name\":\"string\",\"priority\":1,\"reservedChannels\":100,\"serviceCode\":\"string\",\"startDate\":\"2019-08-24T14:15:22Z\",\"type\":\"CALL\",\"usersToNotify\":[\"string\"]}")
.asString();
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign"
payload := strings.NewReader("{\"abilitazioneId\":0,\"busyChannels\":400,\"busyChannelsType\":\"PRESENT\",\"enabled\":true,\"endDate\":\"2019-08-24T14:15:22Z\",\"id\":0,\"lists\":[{\"enabled\":true,\"listId\":0,\"priority\":0}],\"name\":\"string\",\"priority\":1,\"reservedChannels\":100,\"serviceCode\":\"string\",\"startDate\":\"2019-08-24T14:15:22Z\",\"type\":\"CALL\",\"usersToNotify\":[\"string\"]}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = JSON.stringify({
"abilitazioneId": 0,
"busyChannels": 400,
"busyChannelsType": "PRESENT",
"enabled": true,
"endDate": "2019-08-24T14:15:22Z",
"id": 0,
"lists": [
{
"enabled": true,
"listId": 0,
"priority": 0
}
],
"name": "string",
"priority": 1,
"reservedChannels": 100,
"serviceCode": "string",
"startDate": "2019-08-24T14:15:22Z",
"type": "CALL",
"usersToNotify": [
"string"
]
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("PUT", "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "PUT",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
abilitazioneId: 0,
busyChannels: 400,
busyChannelsType: 'PRESENT',
enabled: true,
endDate: '2019-08-24T14:15:22Z',
id: 0,
lists: [{enabled: true, listId: 0, priority: 0}],
name: 'string',
priority: 1,
reservedChannels: 100,
serviceCode: 'string',
startDate: '2019-08-24T14:15:22Z',
type: 'CALL',
usersToNotify: ['string']
}));
req.end();
import http.client
conn = http.client.HTTPSConnection("")
payload = "{\"abilitazioneId\":0,\"busyChannels\":400,\"busyChannelsType\":\"PRESENT\",\"enabled\":true,\"endDate\":\"2019-08-24T14:15:22Z\",\"id\":0,\"lists\":[{\"enabled\":true,\"listId\":0,\"priority\":0}],\"name\":\"string\",\"priority\":1,\"reservedChannels\":100,\"serviceCode\":\"string\",\"startDate\":\"2019-08-24T14:15:22Z\",\"type\":\"CALL\",\"usersToNotify\":[\"string\"]}"
headers = {
'Content-Type': "application/json",
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("PUT", "%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
request.body = "{\"abilitazioneId\":0,\"busyChannels\":400,\"busyChannelsType\":\"PRESENT\",\"enabled\":true,\"endDate\":\"2019-08-24T14:15:22Z\",\"id\":0,\"lists\":[{\"enabled\":true,\"listId\":0,\"priority\":0}],\"name\":\"string\",\"priority\":1,\"reservedChannels\":100,\"serviceCode\":\"string\",\"startDate\":\"2019-08-24T14:15:22Z\",\"type\":\"CALL\",\"usersToNotify\":[\"string\"]}"
response = http.request(request)
puts response.read_body
PUT /rest/powerdialer/campaign
Parameters
Body parameter
{
"abilitazioneId": 0,
"busyChannels": 400,
"busyChannelsType": "PRESENT",
"enabled": true,
"endDate": "2019-08-24T14:15:22Z",
"id": 0,
"lists": [
{
"enabled": true,
"listId": 0,
"priority": 0
}
],
"name": "string",
"priority": 1,
"reservedChannels": 100,
"serviceCode": "string",
"startDate": "2019-08-24T14:15:22Z",
"type": "CALL",
"usersToNotify": [
"string"
]
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| resetStats | query | boolean | false | Reset campaign stats after its update (if active, campaign will be restarted) |
| body | body | PDCampaign | true | Campaign to update |
Responses
Example responses
default Response
{
"abilitazioneId": 0,
"busyChannels": 400,
"busyChannelsType": "PRESENT",
"enabled": true,
"endDate": "2019-08-24T14:15:22Z",
"id": 0,
"lists": [
{
"enabled": true,
"listId": 0,
"priority": 0
}
],
"name": "string",
"priority": 1,
"reservedChannels": 100,
"serviceCode": "string",
"startDate": "2019-08-24T14:15:22Z",
"type": "CALL",
"usersToNotify": [
"string"
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| 404 | Not Found | Error: Object was not found. | GenericObjectWasNotFoundException |
| 406 | Not Acceptable | Error: Invalid argument. | InvalidArgumentException |
| 412 | Precondition Failed | Error: Object required. A required field is missing or empty | GenericObjectRequiredException |
| default | Default | Updated campaign | PDCampaign |
Delete campaign
Code samples
POST %3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/delete HTTP/1.1
Content-Type: */*
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
Content-Length: 3
[0]
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/delete",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "[0]",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Content-Type: */*",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request POST \
--url https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/delete \
--header 'Accept: application/json' \
--header 'Content-Type: */*' \
--header 'Cookie: JSESSIONID=SESSION_ID' \
--data '[0]'
HttpResponse<String> response = Unirest.post("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/delete")
.header("Content-Type", "*/*")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.body("[0]")
.asString();
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/delete"
payload := strings.NewReader("[0]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "*/*")
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = "[0]";
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("POST", "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/delete");
xhr.setRequestHeader("Content-Type", "*/*");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "POST",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/delete",
"headers": {
"Content-Type": "*/*",
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write("[0]");
req.end();
import http.client
conn = http.client.HTTPSConnection("")
payload = "[0]"
headers = {
'Content-Type': "*/*",
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("POST", "%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/delete", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/delete")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Post.new(url)
request["Content-Type"] = '*/*'
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
request.body = "[0]"
response = http.request(request)
puts response.read_body
POST /rest/powerdialer/campaign/delete
Parameters
Body parameter
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | [array[integer]] | true | Campaign id |
Responses
Example responses
default Response
true
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| 404 | Not Found | Error: Object was not found. | GenericObjectWasNotFoundException |
| 412 | Precondition Failed | Error: Object required. A required field is missing or empty | GenericObjectRequiredException |
| default | Default | Campaign deleted | boolean |
Get runs for instant messaging campaign
Code samples
GET %3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/instantmessaging/runs/0 HTTP/1.1
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/instantmessaging/runs/0",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request GET \
--url https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/instantmessaging/runs/0 \
--header 'Accept: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID'
HttpResponse<String> response = Unirest.get("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/instantmessaging/runs/0")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.asString();
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/instantmessaging/runs/0"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("GET", "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/instantmessaging/runs/0");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "GET",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/instantmessaging/runs/0",
"headers": {
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
import http.client
conn = http.client.HTTPSConnection("")
headers = {
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("GET", "%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/instantmessaging/runs/0", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/instantmessaging/runs/0")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
response = http.request(request)
puts response.read_body
GET /rest/powerdialer/campaign/instantmessaging/runs/{id}
Runs are searched within the same month. If the start date is specified, this determines the month of the search; in this case the end date cannot exceed the month of the start date. Otherwise, if only the end date is specified, this determines the search month. If no date is specified, the search month is the current.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | Campaign id |
| startDate | query | string(date-time) | false | Campaign scheduled start date |
| endDate | query | string(date-time) | false | Campaign scheduled end date |
| runName | query | string | false | Campaign run name |
| runStatus | query | [array[string]] | false | Campaign run status |
| template | query | string | false | Template used to execute the run |
| number | query | string | false | Number used to execute the run |
| orderByStartDate | query | string | false | Campaign scheduled start date order by |
| orderByEndDate | query | string | false | Campaign scheduled end date order by |
| pageNumber | query | integer(int32) | false | Page number |
| pageSize | query | integer(int32) | false | Page size |
Enumerated Values
| Parameter | Value |
|---|---|
| runStatus | DISABLE |
| runStatus | SCHEDULED |
| runStatus | ACTIVE |
| runStatus | ACTIVE_QUEUED |
| runStatus | EVALUATING_RESULT |
| runStatus | PENDING |
| runStatus | STOPPING |
| runStatus | STOPPED |
| runStatus | END |
| runStatus | ERROR |
| orderByStartDate | ASC |
| orderByStartDate | DESC |
| orderByEndDate | ASC |
| orderByEndDate | DESC |
Responses
Example responses
default Response
{
"result": [
{
"campaignId": 0,
"contacts": [
{
"campaignId": 0,
"customFields": {
"property1": "string",
"property2": "string"
},
"id": "string",
"itemContactType": "T4YOU",
"itemNumber": 0,
"templateLanguage": "IT",
"value": "string"
}
],
"endDate": "2019-08-24T14:15:22Z",
"id": 0,
"instantMessagingEndDate": "2019-08-24T14:15:22Z",
"instantMessagingRunStatus": "DISABLE",
"instantMessagingStartDate": "2019-08-24T14:15:22Z",
"instantMessagingStatusDetail": "string",
"listId": 0,
"name": "string",
"number": "string",
"runStatus": "DISABLE",
"scheduledEndDate": "2019-08-24T14:15:22Z",
"scheduledStartDate": "2019-08-24T14:15:22Z",
"startDate": "2019-08-24T14:15:22Z",
"template": "string"
}
],
"tot": 0
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| default | Default | Instant messaging campaing runs | SearchResultPDCampaignRun |
Start instant messaging campaign
Code samples
POST %3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/instantmessaging/start/0?startDate=2019-08-24T14%3A15%3A22Z&endDate=2019-08-24T14%3A15%3A22Z&runName=string HTTP/1.1
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/instantmessaging/start/0?startDate=2019-08-24T14%3A15%3A22Z&endDate=2019-08-24T14%3A15%3A22Z&runName=string",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request POST \
--url 'https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/instantmessaging/start/0?startDate=2019-08-24T14%3A15%3A22Z&endDate=2019-08-24T14%3A15%3A22Z&runName=string' \
--header 'Accept: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID'
HttpResponse<String> response = Unirest.post("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/instantmessaging/start/0?startDate=2019-08-24T14%3A15%3A22Z&endDate=2019-08-24T14%3A15%3A22Z&runName=string")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.asString();
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/instantmessaging/start/0?startDate=2019-08-24T14%3A15%3A22Z&endDate=2019-08-24T14%3A15%3A22Z&runName=string"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("POST", "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/instantmessaging/start/0?startDate=2019-08-24T14%3A15%3A22Z&endDate=2019-08-24T14%3A15%3A22Z&runName=string");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "POST",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/instantmessaging/start/0?startDate=2019-08-24T14%3A15%3A22Z&endDate=2019-08-24T14%3A15%3A22Z&runName=string",
"headers": {
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
import http.client
conn = http.client.HTTPSConnection("")
headers = {
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("POST", "%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/instantmessaging/start/0?startDate=2019-08-24T14%3A15%3A22Z&endDate=2019-08-24T14%3A15%3A22Z&runName=string", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/instantmessaging/start/0?startDate=2019-08-24T14%3A15%3A22Z&endDate=2019-08-24T14%3A15%3A22Z&runName=string")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Post.new(url)
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
response = http.request(request)
puts response.read_body
POST /rest/powerdialer/campaign/instantmessaging/start/{id}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | Run id |
| startDate | query | string(date-time) | true | Campaign start date (ISO-8601 format: yyyy-MM-ddTHH:mm:ss.SSSZ. Example: 1970-01-01T00:00:00.000+0000) |
| endDate | query | string(date-time) | true | Campaign end date (ISO-8601 format: yyyy-MM-ddTHH:mm:ss.SSSZ. Example: 1970-01-01T00:00:00.000+0000) |
| runName | query | string | true | Campaign run name |
Responses
Example responses
default Response
"string"
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| 404 | Not Found | Error: Object was not found. | GenericObjectWasNotFoundException |
| 412 | Precondition Failed | Error: Object required. A required field is missing or empty | GenericObjectRequiredException |
| default | Default | Campaign run id | string |
Stop instant messaging campaign run
Code samples
POST %3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/instantmessaging/stop/0 HTTP/1.1
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/instantmessaging/stop/0",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request POST \
--url https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/instantmessaging/stop/0 \
--header 'Accept: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID'
HttpResponse<String> response = Unirest.post("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/instantmessaging/stop/0")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.asString();
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/instantmessaging/stop/0"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("POST", "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/instantmessaging/stop/0");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "POST",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/instantmessaging/stop/0",
"headers": {
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
import http.client
conn = http.client.HTTPSConnection("")
headers = {
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("POST", "%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/instantmessaging/stop/0", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/instantmessaging/stop/0")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Post.new(url)
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
response = http.request(request)
puts response.read_body
POST /rest/powerdialer/campaign/instantmessaging/stop/{runId}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| runId | path | integer(int32) | true | Campaign run id |
Responses
Example responses
default Response
true
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| 404 | Not Found | Error: Object was not found. | GenericObjectWasNotFoundException |
| 412 | Precondition Failed | Error: Object required. A required field is missing or empty | GenericObjectRequiredException |
| default | Default | Campaign stopped | boolean |
Search campaigns
Code samples
GET %3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/search HTTP/1.1
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request GET \
--url https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/search \
--header 'Accept: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID'
HttpResponse<String> response = Unirest.get("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/search")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.asString();
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/search"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("GET", "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/search");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "GET",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/search",
"headers": {
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
import http.client
conn = http.client.HTTPSConnection("")
headers = {
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("GET", "%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/search", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
response = http.request(request)
puts response.read_body
GET /rest/powerdialer/campaign/search
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| term | query | string | false | Term to search within the campaign id or name |
| type | query | [array[string]] | false | Type of campaign |
| priority | query | integer(int32) | false | Campaign priority |
| pageNumber | query | integer(int32) | false | Page number (must be greater than 0) |
| pageSize | query | integer(int32) | false | Page size (must be greater than 0) |
| excludeCampaigns | query | [array[integer]] | false | Search excluding this service codes |
Enumerated Values
| Parameter | Value |
|---|---|
| type | CALL |
| type | INSTANT_MESSAGING |
Responses
Example responses
default Response
{
"result": [
{
"abilitazioneId": 0,
"busyChannels": 400,
"busyChannelsType": "PRESENT",
"enabled": true,
"endDate": "2019-08-24T14:15:22Z",
"id": 0,
"lists": [
{
"enabled": true,
"listId": 0,
"priority": 0
}
],
"name": "string",
"priority": 1,
"reservedChannels": 100,
"serviceCode": "string",
"startDate": "2019-08-24T14:15:22Z",
"type": "CALL",
"usersToNotify": [
"string"
]
}
],
"tot": 0
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| default | Default | Searched campaigns | SearchResultPDCampaign |
Start campaign
Code samples
POST %3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/start/0 HTTP/1.1
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/start/0",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request POST \
--url https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/start/0 \
--header 'Accept: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID'
HttpResponse<String> response = Unirest.post("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/start/0")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.asString();
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/start/0"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("POST", "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/start/0");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "POST",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/start/0",
"headers": {
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
import http.client
conn = http.client.HTTPSConnection("")
headers = {
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("POST", "%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/start/0", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/start/0")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Post.new(url)
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
response = http.request(request)
puts response.read_body
POST /rest/powerdialer/campaign/start/{id}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | Campaign id |
| resetStats | query | boolean | false | Reset campaign stats before start |
Responses
Example responses
default Response
true
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| 404 | Not Found | Error: Object was not found. | GenericObjectWasNotFoundException |
| 412 | Precondition Failed | Error: Object required. A required field is missing or empty | GenericObjectRequiredException |
| default | Default | Campaign started | boolean |
Reset campaign stats
Code samples
POST %3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/stats/reset/0 HTTP/1.1
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/stats/reset/0",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request POST \
--url https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/stats/reset/0 \
--header 'Accept: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID'
HttpResponse<String> response = Unirest.post("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/stats/reset/0")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.asString();
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/stats/reset/0"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("POST", "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/stats/reset/0");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "POST",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/stats/reset/0",
"headers": {
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
import http.client
conn = http.client.HTTPSConnection("")
headers = {
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("POST", "%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/stats/reset/0", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/stats/reset/0")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Post.new(url)
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
response = http.request(request)
puts response.read_body
POST /rest/powerdialer/campaign/stats/reset/{id}
Reset campaign stats and make available to it the new contacts in all the lists associated with the campaign.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | Campaign id |
Responses
Example responses
default Response
true
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| 404 | Not Found | Error: Object was not found. | GenericObjectWasNotFoundException |
| 412 | Precondition Failed | Error: Object required. A required field is missing or empty | GenericObjectRequiredException |
| default | Default | Campaign stats reset | boolean |
Stop campaign
Code samples
POST %3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/stop/0 HTTP/1.1
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/stop/0",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request POST \
--url https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/stop/0 \
--header 'Accept: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID'
HttpResponse<String> response = Unirest.post("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/stop/0")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.asString();
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/stop/0"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("POST", "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/stop/0");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "POST",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/stop/0",
"headers": {
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
import http.client
conn = http.client.HTTPSConnection("")
headers = {
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("POST", "%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/stop/0", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/stop/0")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Post.new(url)
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
response = http.request(request)
puts response.read_body
POST /rest/powerdialer/campaign/stop/{id}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | Campaign id |
| resetStats | query | boolean | false | Reset campaign stats after stop |
Responses
Example responses
default Response
true
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| 404 | Not Found | Error: Object was not found. | GenericObjectWasNotFoundException |
| 412 | Precondition Failed | Error: Object required. A required field is missing or empty | GenericObjectRequiredException |
| default | Default | Campaign stopped | boolean |
Get campaign
Code samples
GET %3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/0 HTTP/1.1
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/0",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request GET \
--url https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/0 \
--header 'Accept: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID'
HttpResponse<String> response = Unirest.get("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/0")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.asString();
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/0"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("GET", "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/0");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "GET",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/0",
"headers": {
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
import http.client
conn = http.client.HTTPSConnection("")
headers = {
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("GET", "%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/0", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/0")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
response = http.request(request)
puts response.read_body
GET /rest/powerdialer/campaign/{id}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | Campaign id |
Responses
Example responses
default Response
{
"abilitazioneId": 0,
"busyChannels": 400,
"busyChannelsType": "PRESENT",
"enabled": true,
"endDate": "2019-08-24T14:15:22Z",
"id": 0,
"lists": [
{
"enabled": true,
"listId": 0,
"priority": 0
}
],
"name": "string",
"priority": 1,
"reservedChannels": 100,
"serviceCode": "string",
"startDate": "2019-08-24T14:15:22Z",
"type": "CALL",
"usersToNotify": [
"string"
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| 404 | Not Found | Error: Object was not found. | GenericObjectWasNotFoundException |
| 412 | Precondition Failed | Error: Object required. A required field is missing or empty | GenericObjectRequiredException |
| default | Default | Requested campaign | PDCampaign |
Add list to campaign
Code samples
POST %3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/0/add-list HTTP/1.1
Content-Type: application/json
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
Content-Length: 42
[{"enabled":true,"listId":0,"priority":0}]
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/0/add-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 => "[{\"enabled\":true,\"listId\":0,\"priority\":0}]",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Content-Type: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request POST \
--url https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/0/add-list \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID' \
--data '[{"enabled":true,"listId":0,"priority":0}]'
HttpResponse<String> response = Unirest.post("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/0/add-list")
.header("Content-Type", "application/json")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.body("[{\"enabled\":true,\"listId\":0,\"priority\":0}]")
.asString();
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/0/add-list"
payload := strings.NewReader("[{\"enabled\":true,\"listId\":0,\"priority\":0}]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = JSON.stringify([
{
"enabled": true,
"listId": 0,
"priority": 0
}
]);
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("POST", "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/0/add-list");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "POST",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/0/add-list",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify([{enabled: true, listId: 0, priority: 0}]));
req.end();
import http.client
conn = http.client.HTTPSConnection("")
payload = "[{\"enabled\":true,\"listId\":0,\"priority\":0}]"
headers = {
'Content-Type': "application/json",
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("POST", "%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/0/add-list", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/0/add-list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
request.body = "[{\"enabled\":true,\"listId\":0,\"priority\":0}]"
response = http.request(request)
puts response.read_body
POST /rest/powerdialer/campaign/{id}/add-list
If a list is already associated with the campaign, this is updated with the new values
Parameters
Body parameter
[
{
"enabled": true,
"listId": 0,
"priority": 0
}
]
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | Campaign id |
| resetStats | query | boolean | false | Reset campaign stats after its update (if active, campaign will be restarted) |
| body | body | [PDCampaignList] | true | List of campaign lists to add |
Responses
Example responses
default Response
0
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| 404 | Not Found | Error: Object was not found. | GenericObjectWasNotFoundException |
| 412 | Precondition Failed | Error: Object required. A required field is missing or empty | GenericObjectRequiredException |
| default | Default | List of campaign list ids added | integer |
Response Schema
Status Code default
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | integer(int32) | false | none | none |
Remove list from campaign
Code samples
DELETE %3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/0/remove-list HTTP/1.1
Content-Type: application/json
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
Content-Length: 3
[0]
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/0/remove-list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_POSTFIELDS => "[0]",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Content-Type: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request DELETE \
--url https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/0/remove-list \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID' \
--data '[0]'
HttpResponse<String> response = Unirest.delete("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/0/remove-list")
.header("Content-Type", "application/json")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.body("[0]")
.asString();
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/0/remove-list"
payload := strings.NewReader("[0]")
req, _ := http.NewRequest("DELETE", url, payload)
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = JSON.stringify([
0
]);
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("DELETE", "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/0/remove-list");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "DELETE",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/0/remove-list",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify([0]));
req.end();
import http.client
conn = http.client.HTTPSConnection("")
payload = "[0]"
headers = {
'Content-Type': "application/json",
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("DELETE", "%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/0/remove-list", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/campaign/0/remove-list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Delete.new(url)
request["Content-Type"] = 'application/json'
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
request.body = "[0]"
response = http.request(request)
puts response.read_body
DELETE /rest/powerdialer/campaign/{id}/remove-list
Parameters
Body parameter
[
0
]
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | Campaign id |
| resetStats | query | boolean | false | Reset campaign stats after its update (if active, campaign will be restarted) |
| body | body | [array[integer]] | false | List of campaign list ids to remove |
Responses
Example responses
default Response
0
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| 404 | Not Found | Error: Object was not found. | GenericObjectWasNotFoundException |
| 412 | Precondition Failed | Error: Object required. A required field is missing or empty | GenericObjectRequiredException |
| default | Default | List of campaign list ids removed | integer |
Response Schema
Status Code default
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | integer(int32) | false | none | none |
Get general settings
Code samples
GET %3CTVOX_HOST%3E/tvox/rest/powerdialer/conf HTTP/1.1
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/conf",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request GET \
--url https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/conf \
--header 'Accept: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID'
HttpResponse<String> response = Unirest.get("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/conf")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.asString();
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/conf"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("GET", "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/conf");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "GET",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/powerdialer/conf",
"headers": {
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
import http.client
conn = http.client.HTTPSConnection("")
headers = {
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("GET", "%3CTVOX_HOST%3E/tvox/rest/powerdialer/conf", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/conf")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
response = http.request(request)
puts response.read_body
GET /rest/powerdialer/conf
Responses
Example responses
default Response
{
"abilitazione": {
"descrizione": "string",
"id": 0
},
"enabled": true,
"maxChannels": 0,
"ringTimeout": 0
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| 510 | Unknown | Error: License exceeded. | LicenceExceededException |
| default | Default | General settings | PDConf |
Update general settings
Code samples
PUT %3CTVOX_HOST%3E/tvox/rest/powerdialer/conf HTTP/1.1
Content-Type: application/json
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
Content-Length: 95
{"abilitazione":{"descrizione":"string","id":0},"enabled":true,"maxChannels":0,"ringTimeout":0}
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/conf",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => "{\"abilitazione\":{\"descrizione\":\"string\",\"id\":0},\"enabled\":true,\"maxChannels\":0,\"ringTimeout\":0}",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Content-Type: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request PUT \
--url https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/conf \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID' \
--data '{"abilitazione":{"descrizione":"string","id":0},"enabled":true,"maxChannels":0,"ringTimeout":0}'
HttpResponse<String> response = Unirest.put("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/conf")
.header("Content-Type", "application/json")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.body("{\"abilitazione\":{\"descrizione\":\"string\",\"id\":0},\"enabled\":true,\"maxChannels\":0,\"ringTimeout\":0}")
.asString();
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/conf"
payload := strings.NewReader("{\"abilitazione\":{\"descrizione\":\"string\",\"id\":0},\"enabled\":true,\"maxChannels\":0,\"ringTimeout\":0}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = JSON.stringify({
"abilitazione": {
"descrizione": "string",
"id": 0
},
"enabled": true,
"maxChannels": 0,
"ringTimeout": 0
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("PUT", "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/conf");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "PUT",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/powerdialer/conf",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
abilitazione: {descrizione: 'string', id: 0},
enabled: true,
maxChannels: 0,
ringTimeout: 0
}));
req.end();
import http.client
conn = http.client.HTTPSConnection("")
payload = "{\"abilitazione\":{\"descrizione\":\"string\",\"id\":0},\"enabled\":true,\"maxChannels\":0,\"ringTimeout\":0}"
headers = {
'Content-Type': "application/json",
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("PUT", "%3CTVOX_HOST%3E/tvox/rest/powerdialer/conf", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/conf")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
request.body = "{\"abilitazione\":{\"descrizione\":\"string\",\"id\":0},\"enabled\":true,\"maxChannels\":0,\"ringTimeout\":0}"
response = http.request(request)
puts response.read_body
PUT /rest/powerdialer/conf
Parameters
Body parameter
{
"abilitazione": {
"descrizione": "string",
"id": 0
},
"enabled": true,
"maxChannels": 0,
"ringTimeout": 0
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | PDConf | true | General settings to update |
Responses
Example responses
default Response
{
"abilitazione": {
"descrizione": "string",
"id": 0
},
"enabled": true,
"maxChannels": 0,
"ringTimeout": 0
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| 412 | Precondition Failed | Error: Object required. A required field is missing or empty | GenericObjectRequiredException |
| 510 | Unknown | Error: License exceeded. | LicenceExceededException |
| default | Default | Updated general settings | PDConf |
Create list for call campaigns
Code samples
POST %3CTVOX_HOST%3E/tvox/rest/powerdialer/list HTTP/1.1
Content-Type: application/json
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
Content-Length: 225
{"busyAttempts":0,"busyTimeout":0,"cancelAttempts":0,"cancelTimeout":0,"congestionAttempts":0,"congestionTimeout":0,"id":0,"name":"string","noAnswerAttempts":0,"noAnswerTimeout":0,"tvoxClosedAttempts":0,"tvoxClosedTimeout":0}
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/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 => "{\"busyAttempts\":0,\"busyTimeout\":0,\"cancelAttempts\":0,\"cancelTimeout\":0,\"congestionAttempts\":0,\"congestionTimeout\":0,\"id\":0,\"name\":\"string\",\"noAnswerAttempts\":0,\"noAnswerTimeout\":0,\"tvoxClosedAttempts\":0,\"tvoxClosedTimeout\":0}",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Content-Type: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request POST \
--url https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID' \
--data '{"busyAttempts":0,"busyTimeout":0,"cancelAttempts":0,"cancelTimeout":0,"congestionAttempts":0,"congestionTimeout":0,"id":0,"name":"string","noAnswerAttempts":0,"noAnswerTimeout":0,"tvoxClosedAttempts":0,"tvoxClosedTimeout":0}'
HttpResponse<String> response = Unirest.post("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list")
.header("Content-Type", "application/json")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.body("{\"busyAttempts\":0,\"busyTimeout\":0,\"cancelAttempts\":0,\"cancelTimeout\":0,\"congestionAttempts\":0,\"congestionTimeout\":0,\"id\":0,\"name\":\"string\",\"noAnswerAttempts\":0,\"noAnswerTimeout\":0,\"tvoxClosedAttempts\":0,\"tvoxClosedTimeout\":0}")
.asString();
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list"
payload := strings.NewReader("{\"busyAttempts\":0,\"busyTimeout\":0,\"cancelAttempts\":0,\"cancelTimeout\":0,\"congestionAttempts\":0,\"congestionTimeout\":0,\"id\":0,\"name\":\"string\",\"noAnswerAttempts\":0,\"noAnswerTimeout\":0,\"tvoxClosedAttempts\":0,\"tvoxClosedTimeout\":0}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = JSON.stringify({
"busyAttempts": 0,
"busyTimeout": 0,
"cancelAttempts": 0,
"cancelTimeout": 0,
"congestionAttempts": 0,
"congestionTimeout": 0,
"id": 0,
"name": "string",
"noAnswerAttempts": 0,
"noAnswerTimeout": 0,
"tvoxClosedAttempts": 0,
"tvoxClosedTimeout": 0
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("POST", "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "POST",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/powerdialer/list",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
busyAttempts: 0,
busyTimeout: 0,
cancelAttempts: 0,
cancelTimeout: 0,
congestionAttempts: 0,
congestionTimeout: 0,
id: 0,
name: 'string',
noAnswerAttempts: 0,
noAnswerTimeout: 0,
tvoxClosedAttempts: 0,
tvoxClosedTimeout: 0
}));
req.end();
import http.client
conn = http.client.HTTPSConnection("")
payload = "{\"busyAttempts\":0,\"busyTimeout\":0,\"cancelAttempts\":0,\"cancelTimeout\":0,\"congestionAttempts\":0,\"congestionTimeout\":0,\"id\":0,\"name\":\"string\",\"noAnswerAttempts\":0,\"noAnswerTimeout\":0,\"tvoxClosedAttempts\":0,\"tvoxClosedTimeout\":0}"
headers = {
'Content-Type': "application/json",
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("POST", "%3CTVOX_HOST%3E/tvox/rest/powerdialer/list", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
request.body = "{\"busyAttempts\":0,\"busyTimeout\":0,\"cancelAttempts\":0,\"cancelTimeout\":0,\"congestionAttempts\":0,\"congestionTimeout\":0,\"id\":0,\"name\":\"string\",\"noAnswerAttempts\":0,\"noAnswerTimeout\":0,\"tvoxClosedAttempts\":0,\"tvoxClosedTimeout\":0}"
response = http.request(request)
puts response.read_body
POST /rest/powerdialer/list
Parameters
Body parameter
{
"busyAttempts": 0,
"busyTimeout": 0,
"cancelAttempts": 0,
"cancelTimeout": 0,
"congestionAttempts": 0,
"congestionTimeout": 0,
"id": 0,
"name": "string",
"noAnswerAttempts": 0,
"noAnswerTimeout": 0,
"tvoxClosedAttempts": 0,
"tvoxClosedTimeout": 0
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | PDList | true | List to create |
Responses
Example responses
default Response
{
"busyAttempts": 0,
"busyTimeout": 0,
"cancelAttempts": 0,
"cancelTimeout": 0,
"congestionAttempts": 0,
"congestionTimeout": 0,
"id": 0,
"name": "string",
"noAnswerAttempts": 0,
"noAnswerTimeout": 0,
"tvoxClosedAttempts": 0,
"tvoxClosedTimeout": 0
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| 409 | Conflict | Error: Object already exists. | GenericObjectExistsException |
| default | Default | Created list | PDList |
Update list for call campaigns
Code samples
PUT %3CTVOX_HOST%3E/tvox/rest/powerdialer/list HTTP/1.1
Content-Type: application/json
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
Content-Length: 225
{"busyAttempts":0,"busyTimeout":0,"cancelAttempts":0,"cancelTimeout":0,"congestionAttempts":0,"congestionTimeout":0,"id":0,"name":"string","noAnswerAttempts":0,"noAnswerTimeout":0,"tvoxClosedAttempts":0,"tvoxClosedTimeout":0}
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => "{\"busyAttempts\":0,\"busyTimeout\":0,\"cancelAttempts\":0,\"cancelTimeout\":0,\"congestionAttempts\":0,\"congestionTimeout\":0,\"id\":0,\"name\":\"string\",\"noAnswerAttempts\":0,\"noAnswerTimeout\":0,\"tvoxClosedAttempts\":0,\"tvoxClosedTimeout\":0}",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Content-Type: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request PUT \
--url https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID' \
--data '{"busyAttempts":0,"busyTimeout":0,"cancelAttempts":0,"cancelTimeout":0,"congestionAttempts":0,"congestionTimeout":0,"id":0,"name":"string","noAnswerAttempts":0,"noAnswerTimeout":0,"tvoxClosedAttempts":0,"tvoxClosedTimeout":0}'
HttpResponse<String> response = Unirest.put("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list")
.header("Content-Type", "application/json")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.body("{\"busyAttempts\":0,\"busyTimeout\":0,\"cancelAttempts\":0,\"cancelTimeout\":0,\"congestionAttempts\":0,\"congestionTimeout\":0,\"id\":0,\"name\":\"string\",\"noAnswerAttempts\":0,\"noAnswerTimeout\":0,\"tvoxClosedAttempts\":0,\"tvoxClosedTimeout\":0}")
.asString();
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list"
payload := strings.NewReader("{\"busyAttempts\":0,\"busyTimeout\":0,\"cancelAttempts\":0,\"cancelTimeout\":0,\"congestionAttempts\":0,\"congestionTimeout\":0,\"id\":0,\"name\":\"string\",\"noAnswerAttempts\":0,\"noAnswerTimeout\":0,\"tvoxClosedAttempts\":0,\"tvoxClosedTimeout\":0}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = JSON.stringify({
"busyAttempts": 0,
"busyTimeout": 0,
"cancelAttempts": 0,
"cancelTimeout": 0,
"congestionAttempts": 0,
"congestionTimeout": 0,
"id": 0,
"name": "string",
"noAnswerAttempts": 0,
"noAnswerTimeout": 0,
"tvoxClosedAttempts": 0,
"tvoxClosedTimeout": 0
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("PUT", "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "PUT",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/powerdialer/list",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
busyAttempts: 0,
busyTimeout: 0,
cancelAttempts: 0,
cancelTimeout: 0,
congestionAttempts: 0,
congestionTimeout: 0,
id: 0,
name: 'string',
noAnswerAttempts: 0,
noAnswerTimeout: 0,
tvoxClosedAttempts: 0,
tvoxClosedTimeout: 0
}));
req.end();
import http.client
conn = http.client.HTTPSConnection("")
payload = "{\"busyAttempts\":0,\"busyTimeout\":0,\"cancelAttempts\":0,\"cancelTimeout\":0,\"congestionAttempts\":0,\"congestionTimeout\":0,\"id\":0,\"name\":\"string\",\"noAnswerAttempts\":0,\"noAnswerTimeout\":0,\"tvoxClosedAttempts\":0,\"tvoxClosedTimeout\":0}"
headers = {
'Content-Type': "application/json",
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("PUT", "%3CTVOX_HOST%3E/tvox/rest/powerdialer/list", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
request.body = "{\"busyAttempts\":0,\"busyTimeout\":0,\"cancelAttempts\":0,\"cancelTimeout\":0,\"congestionAttempts\":0,\"congestionTimeout\":0,\"id\":0,\"name\":\"string\",\"noAnswerAttempts\":0,\"noAnswerTimeout\":0,\"tvoxClosedAttempts\":0,\"tvoxClosedTimeout\":0}"
response = http.request(request)
puts response.read_body
PUT /rest/powerdialer/list
Parameters
Body parameter
{
"busyAttempts": 0,
"busyTimeout": 0,
"cancelAttempts": 0,
"cancelTimeout": 0,
"congestionAttempts": 0,
"congestionTimeout": 0,
"id": 0,
"name": "string",
"noAnswerAttempts": 0,
"noAnswerTimeout": 0,
"tvoxClosedAttempts": 0,
"tvoxClosedTimeout": 0
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | PDList | true | List to update |
Responses
Example responses
default Response
{
"busyAttempts": 0,
"busyTimeout": 0,
"cancelAttempts": 0,
"cancelTimeout": 0,
"congestionAttempts": 0,
"congestionTimeout": 0,
"id": 0,
"name": "string",
"noAnswerAttempts": 0,
"noAnswerTimeout": 0,
"tvoxClosedAttempts": 0,
"tvoxClosedTimeout": 0
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| 404 | Not Found | Error: Object was not found. | GenericObjectWasNotFoundException |
| 412 | Precondition Failed | Error: Object required. A required field is missing or empty | GenericObjectRequiredException |
| default | Default | Updated list | PDList |
Delete list by name for call campaigns
Code samples
DELETE %3CTVOX_HOST%3E/tvox/rest/powerdialer/list-by-name/string HTTP/1.1
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list-by-name/string",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request DELETE \
--url https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list-by-name/string \
--header 'Accept: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID'
HttpResponse<String> response = Unirest.delete("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list-by-name/string")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.asString();
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list-by-name/string"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("DELETE", "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list-by-name/string");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "DELETE",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/powerdialer/list-by-name/string",
"headers": {
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
import http.client
conn = http.client.HTTPSConnection("")
headers = {
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("DELETE", "%3CTVOX_HOST%3E/tvox/rest/powerdialer/list-by-name/string", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list-by-name/string")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Delete.new(url)
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
response = http.request(request)
puts response.read_body
DELETE /rest/powerdialer/list-by-name/{name}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | List name |
| forceRemoveFromCampaigns | query | boolean | false | Force removing list from campaigns before delete |
| resetStats | query | boolean | false | Reset campaign stats after its update (if active, campaign will be restarted) |
Responses
Example responses
default Response
true
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| 403 | Forbidden | Error: Object is in use by another object. | GenericObjectIsInUseException |
| 404 | Not Found | Error: Object was not found. | GenericObjectWasNotFoundException |
| 412 | Precondition Failed | Error: Object required. A required field is missing or empty | GenericObjectRequiredException |
| default | Default | List deleted | boolean |
Delete list items (contacts) for call channel
Code samples
DELETE %3CTVOX_HOST%3E/tvox/rest/powerdialer/list/items HTTP/1.1
Content-Type: application/json
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
Content-Length: 437
[{"campaignId":0,"contactInfo":{"addressbookBackendIds":["string"],"cap":"string","city":"string","company":"string","country":"string","department":"string","district":"string","id":"string","name":"string","organization":true,"otherName":"string","street":"string","surname":"string","vip":true},"data":["string"],"deleteResult":"DELETED","id":0,"itemNumber":0,"listId":0,"phoneNumber":"string","scheduledDate":"2019-08-24T14:15:22Z"}]
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/items",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_POSTFIELDS => "[{\"campaignId\":0,\"contactInfo\":{\"addressbookBackendIds\":[\"string\"],\"cap\":\"string\",\"city\":\"string\",\"company\":\"string\",\"country\":\"string\",\"department\":\"string\",\"district\":\"string\",\"id\":\"string\",\"name\":\"string\",\"organization\":true,\"otherName\":\"string\",\"street\":\"string\",\"surname\":\"string\",\"vip\":true},\"data\":[\"string\"],\"deleteResult\":\"DELETED\",\"id\":0,\"itemNumber\":0,\"listId\":0,\"phoneNumber\":\"string\",\"scheduledDate\":\"2019-08-24T14:15:22Z\"}]",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Content-Type: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request DELETE \
--url https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/items \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID' \
--data '[{"campaignId":0,"contactInfo":{"addressbookBackendIds":["string"],"cap":"string","city":"string","company":"string","country":"string","department":"string","district":"string","id":"string","name":"string","organization":true,"otherName":"string","street":"string","surname":"string","vip":true},"data":["string"],"deleteResult":"DELETED","id":0,"itemNumber":0,"listId":0,"phoneNumber":"string","scheduledDate":"2019-08-24T14:15:22Z"}]'
HttpResponse<String> response = Unirest.delete("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/items")
.header("Content-Type", "application/json")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.body("[{\"campaignId\":0,\"contactInfo\":{\"addressbookBackendIds\":[\"string\"],\"cap\":\"string\",\"city\":\"string\",\"company\":\"string\",\"country\":\"string\",\"department\":\"string\",\"district\":\"string\",\"id\":\"string\",\"name\":\"string\",\"organization\":true,\"otherName\":\"string\",\"street\":\"string\",\"surname\":\"string\",\"vip\":true},\"data\":[\"string\"],\"deleteResult\":\"DELETED\",\"id\":0,\"itemNumber\":0,\"listId\":0,\"phoneNumber\":\"string\",\"scheduledDate\":\"2019-08-24T14:15:22Z\"}]")
.asString();
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/items"
payload := strings.NewReader("[{\"campaignId\":0,\"contactInfo\":{\"addressbookBackendIds\":[\"string\"],\"cap\":\"string\",\"city\":\"string\",\"company\":\"string\",\"country\":\"string\",\"department\":\"string\",\"district\":\"string\",\"id\":\"string\",\"name\":\"string\",\"organization\":true,\"otherName\":\"string\",\"street\":\"string\",\"surname\":\"string\",\"vip\":true},\"data\":[\"string\"],\"deleteResult\":\"DELETED\",\"id\":0,\"itemNumber\":0,\"listId\":0,\"phoneNumber\":\"string\",\"scheduledDate\":\"2019-08-24T14:15:22Z\"}]")
req, _ := http.NewRequest("DELETE", url, payload)
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = JSON.stringify([
{
"campaignId": 0,
"contactInfo": {
"addressbookBackendIds": [
"string"
],
"cap": "string",
"city": "string",
"company": "string",
"country": "string",
"department": "string",
"district": "string",
"id": "string",
"name": "string",
"organization": true,
"otherName": "string",
"street": "string",
"surname": "string",
"vip": true
},
"data": [
"string"
],
"deleteResult": "DELETED",
"id": 0,
"itemNumber": 0,
"listId": 0,
"phoneNumber": "string",
"scheduledDate": "2019-08-24T14:15:22Z"
}
]);
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("DELETE", "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/items");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "DELETE",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/items",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify([
{
campaignId: 0,
contactInfo: {
addressbookBackendIds: ['string'],
cap: 'string',
city: 'string',
company: 'string',
country: 'string',
department: 'string',
district: 'string',
id: 'string',
name: 'string',
organization: true,
otherName: 'string',
street: 'string',
surname: 'string',
vip: true
},
data: ['string'],
deleteResult: 'DELETED',
id: 0,
itemNumber: 0,
listId: 0,
phoneNumber: 'string',
scheduledDate: '2019-08-24T14:15:22Z'
}
]));
req.end();
import http.client
conn = http.client.HTTPSConnection("")
payload = "[{\"campaignId\":0,\"contactInfo\":{\"addressbookBackendIds\":[\"string\"],\"cap\":\"string\",\"city\":\"string\",\"company\":\"string\",\"country\":\"string\",\"department\":\"string\",\"district\":\"string\",\"id\":\"string\",\"name\":\"string\",\"organization\":true,\"otherName\":\"string\",\"street\":\"string\",\"surname\":\"string\",\"vip\":true},\"data\":[\"string\"],\"deleteResult\":\"DELETED\",\"id\":0,\"itemNumber\":0,\"listId\":0,\"phoneNumber\":\"string\",\"scheduledDate\":\"2019-08-24T14:15:22Z\"}]"
headers = {
'Content-Type': "application/json",
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("DELETE", "%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/items", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/items")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Delete.new(url)
request["Content-Type"] = 'application/json'
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
request.body = "[{\"campaignId\":0,\"contactInfo\":{\"addressbookBackendIds\":[\"string\"],\"cap\":\"string\",\"city\":\"string\",\"company\":\"string\",\"country\":\"string\",\"department\":\"string\",\"district\":\"string\",\"id\":\"string\",\"name\":\"string\",\"organization\":true,\"otherName\":\"string\",\"street\":\"string\",\"surname\":\"string\",\"vip\":true},\"data\":[\"string\"],\"deleteResult\":\"DELETED\",\"id\":0,\"itemNumber\":0,\"listId\":0,\"phoneNumber\":\"string\",\"scheduledDate\":\"2019-08-24T14:15:22Z\"}]"
response = http.request(request)
puts response.read_body
DELETE /rest/powerdialer/list/items
Delete items (contacts) from a list associated with a campaign.
Once contacts have been deleted, it is necessary to perform a reset of campaign list stats to consolidate them (query param: resetStats).
Parameters
Body parameter
[
{
"campaignId": 0,
"contactInfo": {
"addressbookBackendIds": [
"string"
],
"cap": "string",
"city": "string",
"company": "string",
"country": "string",
"department": "string",
"district": "string",
"id": "string",
"name": "string",
"organization": true,
"otherName": "string",
"street": "string",
"surname": "string",
"vip": true
},
"data": [
"string"
],
"deleteResult": "DELETED",
"id": 0,
"itemNumber": 0,
"listId": 0,
"phoneNumber": "string",
"scheduledDate": "2019-08-24T14:15:22Z"
}
]
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| resetStats | query | boolean | false | Reset campaign list stats after items deleting (if active, campaign will be restarted) |
| body | body | [PDInterfaceItem] | true | List items (contacts) to delete |
Responses
Example responses
default Response
{
"campaignId": 0,
"contactInfo": {
"addressbookBackendIds": [
"string"
],
"cap": "string",
"city": "string",
"company": "string",
"country": "string",
"department": "string",
"district": "string",
"id": "string",
"name": "string",
"organization": true,
"otherName": "string",
"street": "string",
"surname": "string",
"vip": true
},
"data": [
"string"
],
"deleteResult": "DELETED",
"id": 0,
"itemNumber": 0,
"listId": 0,
"phoneNumber": "string",
"scheduledDate": "2019-08-24T14:15:22Z"
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| 412 | Precondition Failed | Error: Object required. A required field is missing or empty | GenericObjectRequiredException |
| default | Default | List items with delete operation result. | [PDInterfaceItem] |
Add list items (contacts) for call channel
Code samples
POST %3CTVOX_HOST%3E/tvox/rest/powerdialer/list/items HTTP/1.1
Content-Type: application/json
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
Content-Length: 437
[{"campaignId":0,"contactInfo":{"addressbookBackendIds":["string"],"cap":"string","city":"string","company":"string","country":"string","department":"string","district":"string","id":"string","name":"string","organization":true,"otherName":"string","street":"string","surname":"string","vip":true},"data":["string"],"deleteResult":"DELETED","id":0,"itemNumber":0,"listId":0,"phoneNumber":"string","scheduledDate":"2019-08-24T14:15:22Z"}]
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/items",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "[{\"campaignId\":0,\"contactInfo\":{\"addressbookBackendIds\":[\"string\"],\"cap\":\"string\",\"city\":\"string\",\"company\":\"string\",\"country\":\"string\",\"department\":\"string\",\"district\":\"string\",\"id\":\"string\",\"name\":\"string\",\"organization\":true,\"otherName\":\"string\",\"street\":\"string\",\"surname\":\"string\",\"vip\":true},\"data\":[\"string\"],\"deleteResult\":\"DELETED\",\"id\":0,\"itemNumber\":0,\"listId\":0,\"phoneNumber\":\"string\",\"scheduledDate\":\"2019-08-24T14:15:22Z\"}]",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Content-Type: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request POST \
--url https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/items \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID' \
--data '[{"campaignId":0,"contactInfo":{"addressbookBackendIds":["string"],"cap":"string","city":"string","company":"string","country":"string","department":"string","district":"string","id":"string","name":"string","organization":true,"otherName":"string","street":"string","surname":"string","vip":true},"data":["string"],"deleteResult":"DELETED","id":0,"itemNumber":0,"listId":0,"phoneNumber":"string","scheduledDate":"2019-08-24T14:15:22Z"}]'
HttpResponse<String> response = Unirest.post("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/items")
.header("Content-Type", "application/json")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.body("[{\"campaignId\":0,\"contactInfo\":{\"addressbookBackendIds\":[\"string\"],\"cap\":\"string\",\"city\":\"string\",\"company\":\"string\",\"country\":\"string\",\"department\":\"string\",\"district\":\"string\",\"id\":\"string\",\"name\":\"string\",\"organization\":true,\"otherName\":\"string\",\"street\":\"string\",\"surname\":\"string\",\"vip\":true},\"data\":[\"string\"],\"deleteResult\":\"DELETED\",\"id\":0,\"itemNumber\":0,\"listId\":0,\"phoneNumber\":\"string\",\"scheduledDate\":\"2019-08-24T14:15:22Z\"}]")
.asString();
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/items"
payload := strings.NewReader("[{\"campaignId\":0,\"contactInfo\":{\"addressbookBackendIds\":[\"string\"],\"cap\":\"string\",\"city\":\"string\",\"company\":\"string\",\"country\":\"string\",\"department\":\"string\",\"district\":\"string\",\"id\":\"string\",\"name\":\"string\",\"organization\":true,\"otherName\":\"string\",\"street\":\"string\",\"surname\":\"string\",\"vip\":true},\"data\":[\"string\"],\"deleteResult\":\"DELETED\",\"id\":0,\"itemNumber\":0,\"listId\":0,\"phoneNumber\":\"string\",\"scheduledDate\":\"2019-08-24T14:15:22Z\"}]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = JSON.stringify([
{
"campaignId": 0,
"contactInfo": {
"addressbookBackendIds": [
"string"
],
"cap": "string",
"city": "string",
"company": "string",
"country": "string",
"department": "string",
"district": "string",
"id": "string",
"name": "string",
"organization": true,
"otherName": "string",
"street": "string",
"surname": "string",
"vip": true
},
"data": [
"string"
],
"deleteResult": "DELETED",
"id": 0,
"itemNumber": 0,
"listId": 0,
"phoneNumber": "string",
"scheduledDate": "2019-08-24T14:15:22Z"
}
]);
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("POST", "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/items");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "POST",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/items",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify([
{
campaignId: 0,
contactInfo: {
addressbookBackendIds: ['string'],
cap: 'string',
city: 'string',
company: 'string',
country: 'string',
department: 'string',
district: 'string',
id: 'string',
name: 'string',
organization: true,
otherName: 'string',
street: 'string',
surname: 'string',
vip: true
},
data: ['string'],
deleteResult: 'DELETED',
id: 0,
itemNumber: 0,
listId: 0,
phoneNumber: 'string',
scheduledDate: '2019-08-24T14:15:22Z'
}
]));
req.end();
import http.client
conn = http.client.HTTPSConnection("")
payload = "[{\"campaignId\":0,\"contactInfo\":{\"addressbookBackendIds\":[\"string\"],\"cap\":\"string\",\"city\":\"string\",\"company\":\"string\",\"country\":\"string\",\"department\":\"string\",\"district\":\"string\",\"id\":\"string\",\"name\":\"string\",\"organization\":true,\"otherName\":\"string\",\"street\":\"string\",\"surname\":\"string\",\"vip\":true},\"data\":[\"string\"],\"deleteResult\":\"DELETED\",\"id\":0,\"itemNumber\":0,\"listId\":0,\"phoneNumber\":\"string\",\"scheduledDate\":\"2019-08-24T14:15:22Z\"}]"
headers = {
'Content-Type': "application/json",
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("POST", "%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/items", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/items")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
request.body = "[{\"campaignId\":0,\"contactInfo\":{\"addressbookBackendIds\":[\"string\"],\"cap\":\"string\",\"city\":\"string\",\"company\":\"string\",\"country\":\"string\",\"department\":\"string\",\"district\":\"string\",\"id\":\"string\",\"name\":\"string\",\"organization\":true,\"otherName\":\"string\",\"street\":\"string\",\"surname\":\"string\",\"vip\":true},\"data\":[\"string\"],\"deleteResult\":\"DELETED\",\"id\":0,\"itemNumber\":0,\"listId\":0,\"phoneNumber\":\"string\",\"scheduledDate\":\"2019-08-24T14:15:22Z\"}]"
response = http.request(request)
puts response.read_body
POST /rest/powerdialer/list/items
Add items (contacts) to a list associated with a campaign; in addition to the contact's phone number, useful information can be entered to generate a screen popup on operator's position, which can be managed via Popup Manager or Notification Service.
Once contacts have been added, it is necessary to perform a reset of campaign list stats to consolidate them and make them available to Power Dialer campaign (query param: resetStats).
In addition, the contact associated with the specified phone number can be created or updated in the addressbook by populating the "contactInfo" field.
Parameters
Body parameter
[
{
"campaignId": 0,
"contactInfo": {
"addressbookBackendIds": [
"string"
],
"cap": "string",
"city": "string",
"company": "string",
"country": "string",
"department": "string",
"district": "string",
"id": "string",
"name": "string",
"organization": true,
"otherName": "string",
"street": "string",
"surname": "string",
"vip": true
},
"data": [
"string"
],
"deleteResult": "DELETED",
"id": 0,
"itemNumber": 0,
"listId": 0,
"phoneNumber": "string",
"scheduledDate": "2019-08-24T14:15:22Z"
}
]
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| resetStats | query | boolean | false | Reset campaign list stats after items adding (if active, campaign will be restarted) |
| body | body | [PDInterfaceItem] | true | List items (contacts) to add |
Responses
Example responses
default Response
{
"campaignId": 0,
"contactInfo": {
"addressbookBackendIds": [
"string"
],
"cap": "string",
"city": "string",
"company": "string",
"country": "string",
"department": "string",
"district": "string",
"id": "string",
"name": "string",
"organization": true,
"otherName": "string",
"street": "string",
"surname": "string",
"vip": true
},
"data": [
"string"
],
"deleteResult": "DELETED",
"id": 0,
"itemNumber": 0,
"listId": 0,
"phoneNumber": "string",
"scheduledDate": "2019-08-24T14:15:22Z"
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| 403 | Forbidden | Error: Object is in use by another object. | GenericObjectIsInUseException |
| 404 | Not Found | Error: Object was not found. | GenericObjectWasNotFoundException |
| 406 | Not Acceptable | Error: Invalid argument. | InvalidArgumentException |
| 412 | Precondition Failed | Error: Object required or exceed max size. A required field is missing or empty or exceed max size | GenericObjectMaxSizeException |
| default | Default | Added list items | [PDInterfaceItem] |
Delete all list items (contacts) for call channel
Code samples
POST %3CTVOX_HOST%3E/tvox/rest/powerdialer/list/items/reset HTTP/1.1
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/items/reset",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request POST \
--url https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/items/reset \
--header 'Accept: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID'
HttpResponse<String> response = Unirest.post("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/items/reset")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.asString();
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/items/reset"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("POST", "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/items/reset");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "POST",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/items/reset",
"headers": {
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
import http.client
conn = http.client.HTTPSConnection("")
headers = {
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("POST", "%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/items/reset", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/items/reset")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Post.new(url)
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
response = http.request(request)
puts response.read_body
POST /rest/powerdialer/list/items/reset
Responses
Example responses
default Response
true
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| default | Default | List items (contacts) reset | boolean |
Search lists for call campaigns
Code samples
GET %3CTVOX_HOST%3E/tvox/rest/powerdialer/list/search HTTP/1.1
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request GET \
--url https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/search \
--header 'Accept: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID'
HttpResponse<String> response = Unirest.get("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/search")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.asString();
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/search"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("GET", "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/search");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "GET",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/search",
"headers": {
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
import http.client
conn = http.client.HTTPSConnection("")
headers = {
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("GET", "%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/search", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
response = http.request(request)
puts response.read_body
GET /rest/powerdialer/list/search
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| term | query | string | false | Term to search within the list id or name |
| pageNumber | query | integer(int32) | false | Page number (must be greater than 0) |
| pageSize | query | integer(int32) | false | Page size (must be greater than 0) |
Responses
Example responses
default Response
{
"result": [
{
"busyAttempts": 0,
"busyTimeout": 0,
"cancelAttempts": 0,
"cancelTimeout": 0,
"congestionAttempts": 0,
"congestionTimeout": 0,
"id": 0,
"name": "string",
"noAnswerAttempts": 0,
"noAnswerTimeout": 0,
"tvoxClosedAttempts": 0,
"tvoxClosedTimeout": 0
}
],
"tot": 0
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| default | Default | Searched lists | SearchResultPDList |
Reset campaign list stats
Code samples
POST %3CTVOX_HOST%3E/tvox/rest/powerdialer/list/stats/reset/0/0 HTTP/1.1
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/stats/reset/0/0",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request POST \
--url https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/stats/reset/0/0 \
--header 'Accept: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID'
HttpResponse<String> response = Unirest.post("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/stats/reset/0/0")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.asString();
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/stats/reset/0/0"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("POST", "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/stats/reset/0/0");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "POST",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/stats/reset/0/0",
"headers": {
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
import http.client
conn = http.client.HTTPSConnection("")
headers = {
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("POST", "%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/stats/reset/0/0", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/stats/reset/0/0")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Post.new(url)
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
response = http.request(request)
puts response.read_body
POST /rest/powerdialer/list/stats/reset/{campaignId}/{listId}
Reset campaign stats and make available to it the new contacts in the a specific list associated with the campaign.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| campaignId | path | integer(int32) | true | Campaign id |
| listId | path | integer(int32) | true | List id |
Responses
Example responses
default Response
true
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| 404 | Not Found | Error: Object was not found. | GenericObjectWasNotFoundException |
| 412 | Precondition Failed | Error: Object required. A required field is missing or empty | GenericObjectRequiredException |
| default | Default | Campaing list stats reset | boolean |
Delete list for call campaigns
Code samples
DELETE %3CTVOX_HOST%3E/tvox/rest/powerdialer/list/0 HTTP/1.1
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/0",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request DELETE \
--url https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/0 \
--header 'Accept: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID'
HttpResponse<String> response = Unirest.delete("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/0")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.asString();
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/0"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("DELETE", "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/0");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "DELETE",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/0",
"headers": {
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
import http.client
conn = http.client.HTTPSConnection("")
headers = {
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("DELETE", "%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/0", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/0")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Delete.new(url)
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
response = http.request(request)
puts response.read_body
DELETE /rest/powerdialer/list/{id}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | List id |
Responses
Example responses
default Response
true
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| 403 | Forbidden | Error: Object is in use by another object. | GenericObjectIsInUseException |
| 404 | Not Found | Error: Object was not found. | GenericObjectWasNotFoundException |
| 412 | Precondition Failed | Error: Object required. A required field is missing or empty | GenericObjectRequiredException |
| default | Default | List deleted | boolean |
Get list for call campaigns
Code samples
GET %3CTVOX_HOST%3E/tvox/rest/powerdialer/list/0 HTTP/1.1
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/0",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request GET \
--url https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/0 \
--header 'Accept: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID'
HttpResponse<String> response = Unirest.get("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/0")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.asString();
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/0"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("GET", "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/0");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "GET",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/0",
"headers": {
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
import http.client
conn = http.client.HTTPSConnection("")
headers = {
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("GET", "%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/0", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/list/0")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
response = http.request(request)
puts response.read_body
GET /rest/powerdialer/list/{id}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | List id |
Responses
Example responses
default Response
{
"busyAttempts": 0,
"busyTimeout": 0,
"cancelAttempts": 0,
"cancelTimeout": 0,
"congestionAttempts": 0,
"congestionTimeout": 0,
"id": 0,
"name": "string",
"noAnswerAttempts": 0,
"noAnswerTimeout": 0,
"tvoxClosedAttempts": 0,
"tvoxClosedTimeout": 0
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| 404 | Not Found | Error: Object was not found. | GenericObjectWasNotFoundException |
| 412 | Precondition Failed | Error: Object required. A required field is missing or empty | GenericObjectRequiredException |
| default | Default | Requested list | PDList |
Get campaign stats
Code samples
POST %3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/campaign-stats HTTP/1.1
Content-Type: application/json
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
Content-Length: 1018
{"pagination":{"pageNumber":0,"pageSize":0},"resultFields":{},"search":{"campaign":{"abilitation":{"description":{"operator":null,"regexp":null,"value":null},"enabled":true,"id":{"operator":null,"value":null}},"enabled":true,"id":{"operator":"NULL","value":[0]},"list":{"id":{"operator":null,"value":null},"name":{"operator":null,"regexp":null,"value":null}},"name":{"operator":"NULL","regexp":"string","value":["string"]},"openFrom":{"operator":"NULL","value":"string","valueLeft":"string","valueRight":"string"},"openTo":{"operator":"NULL","value":"string","valueLeft":"string","valueRight":"string"},"priority":{"operator":"NULL","value":[0]},"service":{"code":{"operator":null,"regexp":null,"value":null},"description":{"operator":null,"regexp":null,"value":null},"serviceType":["["]}},"executionId":{"operator":"NULL","value":[0]},"listId":{"operator":"NULL","value":[0]},"month":0,"status":{"operator":"NULL","regexp":"string","value":["string"]},"year":0},"sorting":{"orderField":"CALL_TIME","orderType":"ASC"}}
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/campaign-stats",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "{\"pagination\":{\"pageNumber\":0,\"pageSize\":0},\"resultFields\":{},\"search\":{\"campaign\":{\"abilitation\":{\"description\":{\"operator\":null,\"regexp\":null,\"value\":null},\"enabled\":true,\"id\":{\"operator\":null,\"value\":null}},\"enabled\":true,\"id\":{\"operator\":\"NULL\",\"value\":[0]},\"list\":{\"id\":{\"operator\":null,\"value\":null},\"name\":{\"operator\":null,\"regexp\":null,\"value\":null}},\"name\":{\"operator\":\"NULL\",\"regexp\":\"string\",\"value\":[\"string\"]},\"openFrom\":{\"operator\":\"NULL\",\"value\":\"string\",\"valueLeft\":\"string\",\"valueRight\":\"string\"},\"openTo\":{\"operator\":\"NULL\",\"value\":\"string\",\"valueLeft\":\"string\",\"valueRight\":\"string\"},\"priority\":{\"operator\":\"NULL\",\"value\":[0]},\"service\":{\"code\":{\"operator\":null,\"regexp\":null,\"value\":null},\"description\":{\"operator\":null,\"regexp\":null,\"value\":null},\"serviceType\":[\"[\"]}},\"executionId\":{\"operator\":\"NULL\",\"value\":[0]},\"listId\":{\"operator\":\"NULL\",\"value\":[0]},\"month\":0,\"status\":{\"operator\":\"NULL\",\"regexp\":\"string\",\"value\":[\"string\"]},\"year\":0},\"sorting\":{\"orderField\":\"CALL_TIME\",\"orderType\":\"ASC\"}}",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Content-Type: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request POST \
--url https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/campaign-stats \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID' \
--data '{"pagination":{"pageNumber":0,"pageSize":0},"resultFields":{},"search":{"campaign":{"abilitation":{"description":{"operator":null,"regexp":null,"value":null},"enabled":true,"id":{"operator":null,"value":null}},"enabled":true,"id":{"operator":"NULL","value":[0]},"list":{"id":{"operator":null,"value":null},"name":{"operator":null,"regexp":null,"value":null}},"name":{"operator":"NULL","regexp":"string","value":["string"]},"openFrom":{"operator":"NULL","value":"string","valueLeft":"string","valueRight":"string"},"openTo":{"operator":"NULL","value":"string","valueLeft":"string","valueRight":"string"},"priority":{"operator":"NULL","value":[0]},"service":{"code":{"operator":null,"regexp":null,"value":null},"description":{"operator":null,"regexp":null,"value":null},"serviceType":["["]}},"executionId":{"operator":"NULL","value":[0]},"listId":{"operator":"NULL","value":[0]},"month":0,"status":{"operator":"NULL","regexp":"string","value":["string"]},"year":0},"sorting":{"orderField":"CALL_TIME","orderType":"ASC"}}'
HttpResponse<String> response = Unirest.post("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/campaign-stats")
.header("Content-Type", "application/json")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.body("{\"pagination\":{\"pageNumber\":0,\"pageSize\":0},\"resultFields\":{},\"search\":{\"campaign\":{\"abilitation\":{\"description\":{\"operator\":null,\"regexp\":null,\"value\":null},\"enabled\":true,\"id\":{\"operator\":null,\"value\":null}},\"enabled\":true,\"id\":{\"operator\":\"NULL\",\"value\":[0]},\"list\":{\"id\":{\"operator\":null,\"value\":null},\"name\":{\"operator\":null,\"regexp\":null,\"value\":null}},\"name\":{\"operator\":\"NULL\",\"regexp\":\"string\",\"value\":[\"string\"]},\"openFrom\":{\"operator\":\"NULL\",\"value\":\"string\",\"valueLeft\":\"string\",\"valueRight\":\"string\"},\"openTo\":{\"operator\":\"NULL\",\"value\":\"string\",\"valueLeft\":\"string\",\"valueRight\":\"string\"},\"priority\":{\"operator\":\"NULL\",\"value\":[0]},\"service\":{\"code\":{\"operator\":null,\"regexp\":null,\"value\":null},\"description\":{\"operator\":null,\"regexp\":null,\"value\":null},\"serviceType\":[\"[\"]}},\"executionId\":{\"operator\":\"NULL\",\"value\":[0]},\"listId\":{\"operator\":\"NULL\",\"value\":[0]},\"month\":0,\"status\":{\"operator\":\"NULL\",\"regexp\":\"string\",\"value\":[\"string\"]},\"year\":0},\"sorting\":{\"orderField\":\"CALL_TIME\",\"orderType\":\"ASC\"}}")
.asString();
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/campaign-stats"
payload := strings.NewReader("{\"pagination\":{\"pageNumber\":0,\"pageSize\":0},\"resultFields\":{},\"search\":{\"campaign\":{\"abilitation\":{\"description\":{\"operator\":null,\"regexp\":null,\"value\":null},\"enabled\":true,\"id\":{\"operator\":null,\"value\":null}},\"enabled\":true,\"id\":{\"operator\":\"NULL\",\"value\":[0]},\"list\":{\"id\":{\"operator\":null,\"value\":null},\"name\":{\"operator\":null,\"regexp\":null,\"value\":null}},\"name\":{\"operator\":\"NULL\",\"regexp\":\"string\",\"value\":[\"string\"]},\"openFrom\":{\"operator\":\"NULL\",\"value\":\"string\",\"valueLeft\":\"string\",\"valueRight\":\"string\"},\"openTo\":{\"operator\":\"NULL\",\"value\":\"string\",\"valueLeft\":\"string\",\"valueRight\":\"string\"},\"priority\":{\"operator\":\"NULL\",\"value\":[0]},\"service\":{\"code\":{\"operator\":null,\"regexp\":null,\"value\":null},\"description\":{\"operator\":null,\"regexp\":null,\"value\":null},\"serviceType\":[\"[\"]}},\"executionId\":{\"operator\":\"NULL\",\"value\":[0]},\"listId\":{\"operator\":\"NULL\",\"value\":[0]},\"month\":0,\"status\":{\"operator\":\"NULL\",\"regexp\":\"string\",\"value\":[\"string\"]},\"year\":0},\"sorting\":{\"orderField\":\"CALL_TIME\",\"orderType\":\"ASC\"}}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = JSON.stringify({
"pagination": {
"pageNumber": 0,
"pageSize": 0
},
"resultFields": {},
"search": {
"campaign": {
"abilitation": {
"description": {
"operator": null,
"regexp": null,
"value": null
},
"enabled": true,
"id": {
"operator": null,
"value": null
}
},
"enabled": true,
"id": {
"operator": "NULL",
"value": [
0
]
},
"list": {
"id": {
"operator": null,
"value": null
},
"name": {
"operator": null,
"regexp": null,
"value": null
}
},
"name": {
"operator": "NULL",
"regexp": "string",
"value": [
"string"
]
},
"openFrom": {
"operator": "NULL",
"value": "string",
"valueLeft": "string",
"valueRight": "string"
},
"openTo": {
"operator": "NULL",
"value": "string",
"valueLeft": "string",
"valueRight": "string"
},
"priority": {
"operator": "NULL",
"value": [
0
]
},
"service": {
"code": {
"operator": null,
"regexp": null,
"value": null
},
"description": {
"operator": null,
"regexp": null,
"value": null
},
"serviceType": [
"["
]
}
},
"executionId": {
"operator": "NULL",
"value": [
0
]
},
"listId": {
"operator": "NULL",
"value": [
0
]
},
"month": 0,
"status": {
"operator": "NULL",
"regexp": "string",
"value": [
"string"
]
},
"year": 0
},
"sorting": {
"orderField": "CALL_TIME",
"orderType": "ASC"
}
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("POST", "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/campaign-stats");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "POST",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/campaign-stats",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
pagination: {pageNumber: 0, pageSize: 0},
resultFields: {},
search: {
campaign: {
abilitation: {
description: {operator: null, regexp: null, value: null},
enabled: true,
id: {operator: null, value: null}
},
enabled: true,
id: {operator: 'NULL', value: [0]},
list: {
id: {operator: null, value: null},
name: {operator: null, regexp: null, value: null}
},
name: {operator: 'NULL', regexp: 'string', value: ['string']},
openFrom: {operator: 'NULL', value: 'string', valueLeft: 'string', valueRight: 'string'},
openTo: {operator: 'NULL', value: 'string', valueLeft: 'string', valueRight: 'string'},
priority: {operator: 'NULL', value: [0]},
service: {
code: {operator: null, regexp: null, value: null},
description: {operator: null, regexp: null, value: null},
serviceType: ['[']
}
},
executionId: {operator: 'NULL', value: [0]},
listId: {operator: 'NULL', value: [0]},
month: 0,
status: {operator: 'NULL', regexp: 'string', value: ['string']},
year: 0
},
sorting: {orderField: 'CALL_TIME', orderType: 'ASC'}
}));
req.end();
import http.client
conn = http.client.HTTPSConnection("")
payload = "{\"pagination\":{\"pageNumber\":0,\"pageSize\":0},\"resultFields\":{},\"search\":{\"campaign\":{\"abilitation\":{\"description\":{\"operator\":null,\"regexp\":null,\"value\":null},\"enabled\":true,\"id\":{\"operator\":null,\"value\":null}},\"enabled\":true,\"id\":{\"operator\":\"NULL\",\"value\":[0]},\"list\":{\"id\":{\"operator\":null,\"value\":null},\"name\":{\"operator\":null,\"regexp\":null,\"value\":null}},\"name\":{\"operator\":\"NULL\",\"regexp\":\"string\",\"value\":[\"string\"]},\"openFrom\":{\"operator\":\"NULL\",\"value\":\"string\",\"valueLeft\":\"string\",\"valueRight\":\"string\"},\"openTo\":{\"operator\":\"NULL\",\"value\":\"string\",\"valueLeft\":\"string\",\"valueRight\":\"string\"},\"priority\":{\"operator\":\"NULL\",\"value\":[0]},\"service\":{\"code\":{\"operator\":null,\"regexp\":null,\"value\":null},\"description\":{\"operator\":null,\"regexp\":null,\"value\":null},\"serviceType\":[\"[\"]}},\"executionId\":{\"operator\":\"NULL\",\"value\":[0]},\"listId\":{\"operator\":\"NULL\",\"value\":[0]},\"month\":0,\"status\":{\"operator\":\"NULL\",\"regexp\":\"string\",\"value\":[\"string\"]},\"year\":0},\"sorting\":{\"orderField\":\"CALL_TIME\",\"orderType\":\"ASC\"}}"
headers = {
'Content-Type': "application/json",
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("POST", "%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/campaign-stats", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/campaign-stats")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
request.body = "{\"pagination\":{\"pageNumber\":0,\"pageSize\":0},\"resultFields\":{},\"search\":{\"campaign\":{\"abilitation\":{\"description\":{\"operator\":null,\"regexp\":null,\"value\":null},\"enabled\":true,\"id\":{\"operator\":null,\"value\":null}},\"enabled\":true,\"id\":{\"operator\":\"NULL\",\"value\":[0]},\"list\":{\"id\":{\"operator\":null,\"value\":null},\"name\":{\"operator\":null,\"regexp\":null,\"value\":null}},\"name\":{\"operator\":\"NULL\",\"regexp\":\"string\",\"value\":[\"string\"]},\"openFrom\":{\"operator\":\"NULL\",\"value\":\"string\",\"valueLeft\":\"string\",\"valueRight\":\"string\"},\"openTo\":{\"operator\":\"NULL\",\"value\":\"string\",\"valueLeft\":\"string\",\"valueRight\":\"string\"},\"priority\":{\"operator\":\"NULL\",\"value\":[0]},\"service\":{\"code\":{\"operator\":null,\"regexp\":null,\"value\":null},\"description\":{\"operator\":null,\"regexp\":null,\"value\":null},\"serviceType\":[\"[\"]}},\"executionId\":{\"operator\":\"NULL\",\"value\":[0]},\"listId\":{\"operator\":\"NULL\",\"value\":[0]},\"month\":0,\"status\":{\"operator\":\"NULL\",\"regexp\":\"string\",\"value\":[\"string\"]},\"year\":0},\"sorting\":{\"orderField\":\"CALL_TIME\",\"orderType\":\"ASC\"}}"
response = http.request(request)
puts response.read_body
POST /rest/powerdialer/mc/campaign-stats
Parameters
Body parameter
{
"pagination": {
"pageNumber": 0,
"pageSize": 0
},
"resultFields": {},
"search": {
"campaign": {
"abilitation": {
"description": {
"operator": null,
"regexp": null,
"value": null
},
"enabled": true,
"id": {
"operator": null,
"value": null
}
},
"enabled": true,
"id": {
"operator": "NULL",
"value": [
0
]
},
"list": {
"id": {
"operator": null,
"value": null
},
"name": {
"operator": null,
"regexp": null,
"value": null
}
},
"name": {
"operator": "NULL",
"regexp": "string",
"value": [
"string"
]
},
"openFrom": {
"operator": "NULL",
"value": "string",
"valueLeft": "string",
"valueRight": "string"
},
"openTo": {
"operator": "NULL",
"value": "string",
"valueLeft": "string",
"valueRight": "string"
},
"priority": {
"operator": "NULL",
"value": [
0
]
},
"service": {
"code": {
"operator": null,
"regexp": null,
"value": null
},
"description": {
"operator": null,
"regexp": null,
"value": null
},
"serviceType": [
"["
]
}
},
"executionId": {
"operator": "NULL",
"value": [
0
]
},
"listId": {
"operator": "NULL",
"value": [
0
]
},
"month": 0,
"status": {
"operator": "NULL",
"regexp": "string",
"value": [
"string"
]
},
"year": 0
},
"sorting": {
"orderField": "CALL_TIME",
"orderType": "ASC"
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | ReportSearchRequestObjectDatamodelSearchPowerDialerInstantMessagingCampaignStatusDatamodelSortKeyPowerDialerEntry | false | none |
Responses
Example responses
default Response
{
"__typename": "string",
"campaign": {
"SMSLimit": 0,
"SMSSequencePosition": 0,
"__typename": "string",
"abilitation": {
"__typename": "string",
"description": "string",
"enabled": true,
"id": 0
},
"enabled": true,
"id": 0,
"instantMessagingExternalAccountPhoneID": "string",
"instantMessagingLimit": 0,
"instantMessagingSequencePosition": 0,
"instantMessagingTemplate": "string",
"list": [
{
"__typename": "string",
"busy": {
"__typename": "string",
"attempts": 0,
"interval": 0
},
"cancel": {
"__typename": "string",
"attempts": 0,
"interval": 0
},
"congestion": {
"__typename": "string",
"attempts": 0,
"interval": 0
},
"id": 0,
"name": "string",
"noAnswer": {
"__typename": "string",
"attempts": 0,
"interval": 0
},
"tvoxClosed": {
"__typename": "string",
"attempts": 0,
"interval": 0
}
}
],
"mailLimit": 0,
"mailSequencePosition": 0,
"massiveMailLimit": 0,
"massiveMailSequencePosition": 0,
"massiveSMSLimit": 0,
"massiveSMSSequencePosition": 0,
"name": "string",
"openFrom": "string",
"openTo": "string",
"priority": 0,
"service": {
"__typename": "string",
"code": "string",
"description": "string"
}
},
"delivered": 0,
"error": 0,
"executionId": 0,
"fromPhoneNumber": "string",
"listId": 0,
"noStatusReceived": 0,
"read": 0,
"sent": 0,
"status": "string",
"totalContacts": 0
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| default | Default | Get campaign stats | [DatamodelPowerDialerInstantMessagingCampaignStatus] |
Check if the import file is valid
Code samples
POST %3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/import/check/string HTTP/1.1
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/import/check/string",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request POST \
--url https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/import/check/string \
--header 'Accept: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID'
HttpResponse<String> response = Unirest.post("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/import/check/string")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.asString();
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/import/check/string"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("POST", "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/import/check/string");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "POST",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/import/check/string",
"headers": {
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
import http.client
conn = http.client.HTTPSConnection("")
headers = {
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("POST", "%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/import/check/string", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/import/check/string")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Post.new(url)
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
response = http.request(request)
puts response.read_body
POST /rest/powerdialer/mc/import/check/{fileName}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| fileName | path | string | true | none |
| maxfields | query | integer(int32) | false | none |
| phoneNumberRegionCode | query | string | false | none |
Responses
Example responses
default Response
{
"errors": [
{}
],
"totalDevice": 0,
"totalUsers": 0
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| default | Default | Check file result | UsersImportCheckResult |
Get the template to import contacts
Code samples
POST %3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/import/template HTTP/1.1
Accept: application/octet-stream
Cookie: JSESSIONID=SESSION_ID
Host:
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/import/template",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Accept: application/octet-stream",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request POST \
--url https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/import/template \
--header 'Accept: application/octet-stream' \
--header 'Cookie: JSESSIONID=SESSION_ID'
HttpResponse<String> response = Unirest.post("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/import/template")
.header("Accept", "application/octet-stream")
.header("Cookie", "JSESSIONID=SESSION_ID")
.asString();
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/import/template"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Accept", "application/octet-stream")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("POST", "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/import/template");
xhr.setRequestHeader("Accept", "application/octet-stream");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "POST",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/import/template",
"headers": {
"Accept": "application/octet-stream",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
import http.client
conn = http.client.HTTPSConnection("")
headers = {
'Accept': "application/octet-stream",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("POST", "%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/import/template", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/import/template")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Post.new(url)
request["Accept"] = 'application/octet-stream'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
response = http.request(request)
puts response.read_body
POST /rest/powerdialer/mc/import/template
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| maxfields | query | integer(int32) | false | none |
Responses
Example responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | File downloaded successfully | string |
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
Import contacts from file
Code samples
POST %3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/import/string/0 HTTP/1.1
Content-Type: application/json
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
Content-Length: 34
{"startIndex":0,"usersToImport":0}
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/import/string/0",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "{\"startIndex\":0,\"usersToImport\":0}",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Content-Type: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request POST \
--url https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/import/string/0 \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID' \
--data '{"startIndex":0,"usersToImport":0}'
HttpResponse<String> response = Unirest.post("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/import/string/0")
.header("Content-Type", "application/json")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.body("{\"startIndex\":0,\"usersToImport\":0}")
.asString();
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/import/string/0"
payload := strings.NewReader("{\"startIndex\":0,\"usersToImport\":0}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = JSON.stringify({
"startIndex": 0,
"usersToImport": 0
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("POST", "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/import/string/0");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "POST",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/import/string/0",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({startIndex: 0, usersToImport: 0}));
req.end();
import http.client
conn = http.client.HTTPSConnection("")
payload = "{\"startIndex\":0,\"usersToImport\":0}"
headers = {
'Content-Type': "application/json",
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("POST", "%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/import/string/0", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/import/string/0")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
request.body = "{\"startIndex\":0,\"usersToImport\":0}"
response = http.request(request)
puts response.read_body
POST /rest/powerdialer/mc/import/{fileName}/{runId}
Parameters
Body parameter
{
"startIndex": 0,
"usersToImport": 0
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| fileName | path | string | true | none |
| runId | path | integer(int32) | true | none |
| maxfields | query | integer(int32) | false | none |
| phoneNumberRegionCode | query | string | false | none |
| body | body | UsersImportRequest | false | none |
Responses
Example responses
default Response
{
"checkerrors": [
{
"cause": "string",
"code": {},
"row": 0,
"sheet": "string"
}
],
"errors": [
{
"errors": [
{}
],
"index": 0,
"username": "string"
}
],
"tot": 0,
"users": [
{
"index": 0,
"username": "string"
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| default | Default | Imported contacts | UsersImportResult |
Add list items (contacts) for multi-channel
Code samples
POST %3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/list/items HTTP/1.1
Content-Type: application/json
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
Content-Length: 173
[{"campaignId":0,"customFields":{"property1":"string","property2":"string"},"id":"string","itemContactType":"T4YOU","itemNumber":0,"templateLanguage":"IT","value":"string"}]
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/list/items",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "[{\"campaignId\":0,\"customFields\":{\"property1\":\"string\",\"property2\":\"string\"},\"id\":\"string\",\"itemContactType\":\"T4YOU\",\"itemNumber\":0,\"templateLanguage\":\"IT\",\"value\":\"string\"}]",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Content-Type: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request POST \
--url https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/list/items \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID' \
--data '[{"campaignId":0,"customFields":{"property1":"string","property2":"string"},"id":"string","itemContactType":"T4YOU","itemNumber":0,"templateLanguage":"IT","value":"string"}]'
HttpResponse<String> response = Unirest.post("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/list/items")
.header("Content-Type", "application/json")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.body("[{\"campaignId\":0,\"customFields\":{\"property1\":\"string\",\"property2\":\"string\"},\"id\":\"string\",\"itemContactType\":\"T4YOU\",\"itemNumber\":0,\"templateLanguage\":\"IT\",\"value\":\"string\"}]")
.asString();
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/list/items"
payload := strings.NewReader("[{\"campaignId\":0,\"customFields\":{\"property1\":\"string\",\"property2\":\"string\"},\"id\":\"string\",\"itemContactType\":\"T4YOU\",\"itemNumber\":0,\"templateLanguage\":\"IT\",\"value\":\"string\"}]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = JSON.stringify([
{
"campaignId": 0,
"customFields": {
"property1": "string",
"property2": "string"
},
"id": "string",
"itemContactType": "T4YOU",
"itemNumber": 0,
"templateLanguage": "IT",
"value": "string"
}
]);
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("POST", "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/list/items");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "POST",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/list/items",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify([
{
campaignId: 0,
customFields: {property1: 'string', property2: 'string'},
id: 'string',
itemContactType: 'T4YOU',
itemNumber: 0,
templateLanguage: 'IT',
value: 'string'
}
]));
req.end();
import http.client
conn = http.client.HTTPSConnection("")
payload = "[{\"campaignId\":0,\"customFields\":{\"property1\":\"string\",\"property2\":\"string\"},\"id\":\"string\",\"itemContactType\":\"T4YOU\",\"itemNumber\":0,\"templateLanguage\":\"IT\",\"value\":\"string\"}]"
headers = {
'Content-Type': "application/json",
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("POST", "%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/list/items", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/list/items")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
request.body = "[{\"campaignId\":0,\"customFields\":{\"property1\":\"string\",\"property2\":\"string\"},\"id\":\"string\",\"itemContactType\":\"T4YOU\",\"itemNumber\":0,\"templateLanguage\":\"IT\",\"value\":\"string\"}]"
response = http.request(request)
puts response.read_body
POST /rest/powerdialer/mc/list/items
Add items (contacts) to a multi-channel campaign (e.g. instant messaging).
Parameters
Body parameter
[
{
"campaignId": 0,
"customFields": {
"property1": "string",
"property2": "string"
},
"id": "string",
"itemContactType": "T4YOU",
"itemNumber": 0,
"templateLanguage": "IT",
"value": "string"
}
]
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| runId | query | integer(int32) | false | Run id |
| body | body | [PDMcInterfaceItem] | true | List items (contacts) to add |
Responses
Example responses
default Response
{
"campaignId": 0,
"customFields": {
"property1": "string",
"property2": "string"
},
"id": "string",
"itemContactType": "T4YOU",
"itemNumber": 0,
"templateLanguage": "IT",
"value": "string"
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| 404 | Not Found | Error: Object was not found. | GenericObjectWasNotFoundException |
| 406 | Not Acceptable | Error: Invalid argument. | InvalidArgumentException |
| 412 | Precondition Failed | Error: Object required. A required field is missing or empty | GenericObjectRequiredException |
| default | Default | Added list items | [PDMcInterfaceItem] |
Delete list items (contacts) for multi-channel
Code samples
DELETE %3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/list/items/0 HTTP/1.1
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/list/items/0",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request DELETE \
--url https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/list/items/0 \
--header 'Accept: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID'
HttpResponse<String> response = Unirest.delete("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/list/items/0")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.asString();
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/list/items/0"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("DELETE", "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/list/items/0");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "DELETE",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/list/items/0",
"headers": {
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
import http.client
conn = http.client.HTTPSConnection("")
headers = {
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("DELETE", "%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/list/items/0", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/list/items/0")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Delete.new(url)
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
response = http.request(request)
puts response.read_body
DELETE /rest/powerdialer/mc/list/items/{campaignId}
Delete items (contacts) from a multi-channel campaign (e.g. instant messaging).
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| campaignId | path | integer(int32) | true | Campaign id |
Responses
Example responses
default Response
{
"campaignId": 0,
"customFields": {
"property1": "string",
"property2": "string"
},
"id": "string",
"itemContactType": "T4YOU",
"itemNumber": 0,
"templateLanguage": "IT",
"value": "string"
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| 404 | Not Found | Error: Object was not found. | GenericObjectWasNotFoundException |
| 412 | Precondition Failed | Error: Object required. A required field is missing or empty | GenericObjectRequiredException |
| default | Default | Deleted list items | [PDMcInterfaceItem] |
Get the list of items (contacts) for multi-channel
Code samples
GET %3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/list/items/0 HTTP/1.1
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/list/items/0",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request GET \
--url https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/list/items/0 \
--header 'Accept: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID'
HttpResponse<String> response = Unirest.get("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/list/items/0")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.asString();
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/list/items/0"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("GET", "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/list/items/0");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "GET",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/list/items/0",
"headers": {
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
import http.client
conn = http.client.HTTPSConnection("")
headers = {
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("GET", "%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/list/items/0", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/list/items/0")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
response = http.request(request)
puts response.read_body
GET /rest/powerdialer/mc/list/items/{campaignId}
Get the list of items (contacts) associated with a multi-channel campaign (e.g. instant messaging).
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| campaignId | path | integer(int32) | true | Campaing id |
| runId | query | integer(int32) | false | Run id |
| processing | query | boolean | false | boolean used to filter items |
Responses
Example responses
default Response
{
"campaignId": 0,
"customFields": {
"property1": "string",
"property2": "string"
},
"id": "string",
"itemContactType": "T4YOU",
"itemNumber": 0,
"templateLanguage": "IT",
"value": "string"
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| 412 | Precondition Failed | Error: Object required. A required field is missing or empty | GenericObjectRequiredException |
| default | Default | Requested items | [PDMcInterfaceItem] |
Get messaging history
Code samples
POST %3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/messaging-history HTTP/1.1
Content-Type: application/json
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
Content-Length: 1613
{"pagination":{"pageNumber":0,"pageSize":0},"resultFields":{},"search":{"campaign":{"abilitation":{"description":{"operator":null,"regexp":null,"value":null},"enabled":true,"id":{"operator":null,"value":null}},"enabled":true,"id":{"operator":"NULL","value":[0]},"list":{"id":{"operator":null,"value":null},"name":{"operator":null,"regexp":null,"value":null}},"name":{"operator":"NULL","regexp":"string","value":["string"]},"openFrom":{"operator":"NULL","value":"string","valueLeft":"string","valueRight":"string"},"openTo":{"operator":"NULL","value":"string","valueLeft":"string","valueRight":"string"},"priority":{"operator":"NULL","value":[0]},"service":{"code":{"operator":null,"regexp":null,"value":null},"description":{"operator":null,"regexp":null,"value":null},"serviceType":["["]}},"contactCustomId":{"operator":"NULL","regexp":"string","value":["string"]},"contactItem":{"operator":"NULL","value":[0]},"contactUUID":{"operator":"NULL","regexp":"string","value":["string"]},"executionId":{"operator":"NULL","value":[0]},"listId":{"operator":"NULL","value":[0]},"messageCloseTime":{"operator":"NULL","value":"string","valueLeft":"string","valueRight":"string"},"messageFromNumber":{"operator":"NULL","regexp":"string","value":["string"]},"messageId":{"operator":"NULL","regexp":"string","value":["string"]},"messageInsertTime":{"operator":"NULL","value":"string","valueLeft":"string","valueRight":"string"},"messageResult":{"operator":"NULL","value":[0]},"messageToNumber":{"operator":"NULL","regexp":"string","value":["string"]},"month":0,"year":0},"sorting":{"orderField":"MESSAGE_ID","orderType":"ASC"}}
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/messaging-history",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "{\"pagination\":{\"pageNumber\":0,\"pageSize\":0},\"resultFields\":{},\"search\":{\"campaign\":{\"abilitation\":{\"description\":{\"operator\":null,\"regexp\":null,\"value\":null},\"enabled\":true,\"id\":{\"operator\":null,\"value\":null}},\"enabled\":true,\"id\":{\"operator\":\"NULL\",\"value\":[0]},\"list\":{\"id\":{\"operator\":null,\"value\":null},\"name\":{\"operator\":null,\"regexp\":null,\"value\":null}},\"name\":{\"operator\":\"NULL\",\"regexp\":\"string\",\"value\":[\"string\"]},\"openFrom\":{\"operator\":\"NULL\",\"value\":\"string\",\"valueLeft\":\"string\",\"valueRight\":\"string\"},\"openTo\":{\"operator\":\"NULL\",\"value\":\"string\",\"valueLeft\":\"string\",\"valueRight\":\"string\"},\"priority\":{\"operator\":\"NULL\",\"value\":[0]},\"service\":{\"code\":{\"operator\":null,\"regexp\":null,\"value\":null},\"description\":{\"operator\":null,\"regexp\":null,\"value\":null},\"serviceType\":[\"[\"]}},\"contactCustomId\":{\"operator\":\"NULL\",\"regexp\":\"string\",\"value\":[\"string\"]},\"contactItem\":{\"operator\":\"NULL\",\"value\":[0]},\"contactUUID\":{\"operator\":\"NULL\",\"regexp\":\"string\",\"value\":[\"string\"]},\"executionId\":{\"operator\":\"NULL\",\"value\":[0]},\"listId\":{\"operator\":\"NULL\",\"value\":[0]},\"messageCloseTime\":{\"operator\":\"NULL\",\"value\":\"string\",\"valueLeft\":\"string\",\"valueRight\":\"string\"},\"messageFromNumber\":{\"operator\":\"NULL\",\"regexp\":\"string\",\"value\":[\"string\"]},\"messageId\":{\"operator\":\"NULL\",\"regexp\":\"string\",\"value\":[\"string\"]},\"messageInsertTime\":{\"operator\":\"NULL\",\"value\":\"string\",\"valueLeft\":\"string\",\"valueRight\":\"string\"},\"messageResult\":{\"operator\":\"NULL\",\"value\":[0]},\"messageToNumber\":{\"operator\":\"NULL\",\"regexp\":\"string\",\"value\":[\"string\"]},\"month\":0,\"year\":0},\"sorting\":{\"orderField\":\"MESSAGE_ID\",\"orderType\":\"ASC\"}}",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Content-Type: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request POST \
--url https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/messaging-history \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID' \
--data '{"pagination":{"pageNumber":0,"pageSize":0},"resultFields":{},"search":{"campaign":{"abilitation":{"description":{"operator":null,"regexp":null,"value":null},"enabled":true,"id":{"operator":null,"value":null}},"enabled":true,"id":{"operator":"NULL","value":[0]},"list":{"id":{"operator":null,"value":null},"name":{"operator":null,"regexp":null,"value":null}},"name":{"operator":"NULL","regexp":"string","value":["string"]},"openFrom":{"operator":"NULL","value":"string","valueLeft":"string","valueRight":"string"},"openTo":{"operator":"NULL","value":"string","valueLeft":"string","valueRight":"string"},"priority":{"operator":"NULL","value":[0]},"service":{"code":{"operator":null,"regexp":null,"value":null},"description":{"operator":null,"regexp":null,"value":null},"serviceType":["["]}},"contactCustomId":{"operator":"NULL","regexp":"string","value":["string"]},"contactItem":{"operator":"NULL","value":[0]},"contactUUID":{"operator":"NULL","regexp":"string","value":["string"]},"executionId":{"operator":"NULL","value":[0]},"listId":{"operator":"NULL","value":[0]},"messageCloseTime":{"operator":"NULL","value":"string","valueLeft":"string","valueRight":"string"},"messageFromNumber":{"operator":"NULL","regexp":"string","value":["string"]},"messageId":{"operator":"NULL","regexp":"string","value":["string"]},"messageInsertTime":{"operator":"NULL","value":"string","valueLeft":"string","valueRight":"string"},"messageResult":{"operator":"NULL","value":[0]},"messageToNumber":{"operator":"NULL","regexp":"string","value":["string"]},"month":0,"year":0},"sorting":{"orderField":"MESSAGE_ID","orderType":"ASC"}}'
HttpResponse<String> response = Unirest.post("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/messaging-history")
.header("Content-Type", "application/json")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.body("{\"pagination\":{\"pageNumber\":0,\"pageSize\":0},\"resultFields\":{},\"search\":{\"campaign\":{\"abilitation\":{\"description\":{\"operator\":null,\"regexp\":null,\"value\":null},\"enabled\":true,\"id\":{\"operator\":null,\"value\":null}},\"enabled\":true,\"id\":{\"operator\":\"NULL\",\"value\":[0]},\"list\":{\"id\":{\"operator\":null,\"value\":null},\"name\":{\"operator\":null,\"regexp\":null,\"value\":null}},\"name\":{\"operator\":\"NULL\",\"regexp\":\"string\",\"value\":[\"string\"]},\"openFrom\":{\"operator\":\"NULL\",\"value\":\"string\",\"valueLeft\":\"string\",\"valueRight\":\"string\"},\"openTo\":{\"operator\":\"NULL\",\"value\":\"string\",\"valueLeft\":\"string\",\"valueRight\":\"string\"},\"priority\":{\"operator\":\"NULL\",\"value\":[0]},\"service\":{\"code\":{\"operator\":null,\"regexp\":null,\"value\":null},\"description\":{\"operator\":null,\"regexp\":null,\"value\":null},\"serviceType\":[\"[\"]}},\"contactCustomId\":{\"operator\":\"NULL\",\"regexp\":\"string\",\"value\":[\"string\"]},\"contactItem\":{\"operator\":\"NULL\",\"value\":[0]},\"contactUUID\":{\"operator\":\"NULL\",\"regexp\":\"string\",\"value\":[\"string\"]},\"executionId\":{\"operator\":\"NULL\",\"value\":[0]},\"listId\":{\"operator\":\"NULL\",\"value\":[0]},\"messageCloseTime\":{\"operator\":\"NULL\",\"value\":\"string\",\"valueLeft\":\"string\",\"valueRight\":\"string\"},\"messageFromNumber\":{\"operator\":\"NULL\",\"regexp\":\"string\",\"value\":[\"string\"]},\"messageId\":{\"operator\":\"NULL\",\"regexp\":\"string\",\"value\":[\"string\"]},\"messageInsertTime\":{\"operator\":\"NULL\",\"value\":\"string\",\"valueLeft\":\"string\",\"valueRight\":\"string\"},\"messageResult\":{\"operator\":\"NULL\",\"value\":[0]},\"messageToNumber\":{\"operator\":\"NULL\",\"regexp\":\"string\",\"value\":[\"string\"]},\"month\":0,\"year\":0},\"sorting\":{\"orderField\":\"MESSAGE_ID\",\"orderType\":\"ASC\"}}")
.asString();
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/messaging-history"
payload := strings.NewReader("{\"pagination\":{\"pageNumber\":0,\"pageSize\":0},\"resultFields\":{},\"search\":{\"campaign\":{\"abilitation\":{\"description\":{\"operator\":null,\"regexp\":null,\"value\":null},\"enabled\":true,\"id\":{\"operator\":null,\"value\":null}},\"enabled\":true,\"id\":{\"operator\":\"NULL\",\"value\":[0]},\"list\":{\"id\":{\"operator\":null,\"value\":null},\"name\":{\"operator\":null,\"regexp\":null,\"value\":null}},\"name\":{\"operator\":\"NULL\",\"regexp\":\"string\",\"value\":[\"string\"]},\"openFrom\":{\"operator\":\"NULL\",\"value\":\"string\",\"valueLeft\":\"string\",\"valueRight\":\"string\"},\"openTo\":{\"operator\":\"NULL\",\"value\":\"string\",\"valueLeft\":\"string\",\"valueRight\":\"string\"},\"priority\":{\"operator\":\"NULL\",\"value\":[0]},\"service\":{\"code\":{\"operator\":null,\"regexp\":null,\"value\":null},\"description\":{\"operator\":null,\"regexp\":null,\"value\":null},\"serviceType\":[\"[\"]}},\"contactCustomId\":{\"operator\":\"NULL\",\"regexp\":\"string\",\"value\":[\"string\"]},\"contactItem\":{\"operator\":\"NULL\",\"value\":[0]},\"contactUUID\":{\"operator\":\"NULL\",\"regexp\":\"string\",\"value\":[\"string\"]},\"executionId\":{\"operator\":\"NULL\",\"value\":[0]},\"listId\":{\"operator\":\"NULL\",\"value\":[0]},\"messageCloseTime\":{\"operator\":\"NULL\",\"value\":\"string\",\"valueLeft\":\"string\",\"valueRight\":\"string\"},\"messageFromNumber\":{\"operator\":\"NULL\",\"regexp\":\"string\",\"value\":[\"string\"]},\"messageId\":{\"operator\":\"NULL\",\"regexp\":\"string\",\"value\":[\"string\"]},\"messageInsertTime\":{\"operator\":\"NULL\",\"value\":\"string\",\"valueLeft\":\"string\",\"valueRight\":\"string\"},\"messageResult\":{\"operator\":\"NULL\",\"value\":[0]},\"messageToNumber\":{\"operator\":\"NULL\",\"regexp\":\"string\",\"value\":[\"string\"]},\"month\":0,\"year\":0},\"sorting\":{\"orderField\":\"MESSAGE_ID\",\"orderType\":\"ASC\"}}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = JSON.stringify({
"pagination": {
"pageNumber": 0,
"pageSize": 0
},
"resultFields": {},
"search": {
"campaign": {
"abilitation": {
"description": {
"operator": null,
"regexp": null,
"value": null
},
"enabled": true,
"id": {
"operator": null,
"value": null
}
},
"enabled": true,
"id": {
"operator": "NULL",
"value": [
0
]
},
"list": {
"id": {
"operator": null,
"value": null
},
"name": {
"operator": null,
"regexp": null,
"value": null
}
},
"name": {
"operator": "NULL",
"regexp": "string",
"value": [
"string"
]
},
"openFrom": {
"operator": "NULL",
"value": "string",
"valueLeft": "string",
"valueRight": "string"
},
"openTo": {
"operator": "NULL",
"value": "string",
"valueLeft": "string",
"valueRight": "string"
},
"priority": {
"operator": "NULL",
"value": [
0
]
},
"service": {
"code": {
"operator": null,
"regexp": null,
"value": null
},
"description": {
"operator": null,
"regexp": null,
"value": null
},
"serviceType": [
"["
]
}
},
"contactCustomId": {
"operator": "NULL",
"regexp": "string",
"value": [
"string"
]
},
"contactItem": {
"operator": "NULL",
"value": [
0
]
},
"contactUUID": {
"operator": "NULL",
"regexp": "string",
"value": [
"string"
]
},
"executionId": {
"operator": "NULL",
"value": [
0
]
},
"listId": {
"operator": "NULL",
"value": [
0
]
},
"messageCloseTime": {
"operator": "NULL",
"value": "string",
"valueLeft": "string",
"valueRight": "string"
},
"messageFromNumber": {
"operator": "NULL",
"regexp": "string",
"value": [
"string"
]
},
"messageId": {
"operator": "NULL",
"regexp": "string",
"value": [
"string"
]
},
"messageInsertTime": {
"operator": "NULL",
"value": "string",
"valueLeft": "string",
"valueRight": "string"
},
"messageResult": {
"operator": "NULL",
"value": [
0
]
},
"messageToNumber": {
"operator": "NULL",
"regexp": "string",
"value": [
"string"
]
},
"month": 0,
"year": 0
},
"sorting": {
"orderField": "MESSAGE_ID",
"orderType": "ASC"
}
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("POST", "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/messaging-history");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "POST",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/messaging-history",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
pagination: {pageNumber: 0, pageSize: 0},
resultFields: {},
search: {
campaign: {
abilitation: {
description: {operator: null, regexp: null, value: null},
enabled: true,
id: {operator: null, value: null}
},
enabled: true,
id: {operator: 'NULL', value: [0]},
list: {
id: {operator: null, value: null},
name: {operator: null, regexp: null, value: null}
},
name: {operator: 'NULL', regexp: 'string', value: ['string']},
openFrom: {operator: 'NULL', value: 'string', valueLeft: 'string', valueRight: 'string'},
openTo: {operator: 'NULL', value: 'string', valueLeft: 'string', valueRight: 'string'},
priority: {operator: 'NULL', value: [0]},
service: {
code: {operator: null, regexp: null, value: null},
description: {operator: null, regexp: null, value: null},
serviceType: ['[']
}
},
contactCustomId: {operator: 'NULL', regexp: 'string', value: ['string']},
contactItem: {operator: 'NULL', value: [0]},
contactUUID: {operator: 'NULL', regexp: 'string', value: ['string']},
executionId: {operator: 'NULL', value: [0]},
listId: {operator: 'NULL', value: [0]},
messageCloseTime: {operator: 'NULL', value: 'string', valueLeft: 'string', valueRight: 'string'},
messageFromNumber: {operator: 'NULL', regexp: 'string', value: ['string']},
messageId: {operator: 'NULL', regexp: 'string', value: ['string']},
messageInsertTime: {operator: 'NULL', value: 'string', valueLeft: 'string', valueRight: 'string'},
messageResult: {operator: 'NULL', value: [0]},
messageToNumber: {operator: 'NULL', regexp: 'string', value: ['string']},
month: 0,
year: 0
},
sorting: {orderField: 'MESSAGE_ID', orderType: 'ASC'}
}));
req.end();
import http.client
conn = http.client.HTTPSConnection("")
payload = "{\"pagination\":{\"pageNumber\":0,\"pageSize\":0},\"resultFields\":{},\"search\":{\"campaign\":{\"abilitation\":{\"description\":{\"operator\":null,\"regexp\":null,\"value\":null},\"enabled\":true,\"id\":{\"operator\":null,\"value\":null}},\"enabled\":true,\"id\":{\"operator\":\"NULL\",\"value\":[0]},\"list\":{\"id\":{\"operator\":null,\"value\":null},\"name\":{\"operator\":null,\"regexp\":null,\"value\":null}},\"name\":{\"operator\":\"NULL\",\"regexp\":\"string\",\"value\":[\"string\"]},\"openFrom\":{\"operator\":\"NULL\",\"value\":\"string\",\"valueLeft\":\"string\",\"valueRight\":\"string\"},\"openTo\":{\"operator\":\"NULL\",\"value\":\"string\",\"valueLeft\":\"string\",\"valueRight\":\"string\"},\"priority\":{\"operator\":\"NULL\",\"value\":[0]},\"service\":{\"code\":{\"operator\":null,\"regexp\":null,\"value\":null},\"description\":{\"operator\":null,\"regexp\":null,\"value\":null},\"serviceType\":[\"[\"]}},\"contactCustomId\":{\"operator\":\"NULL\",\"regexp\":\"string\",\"value\":[\"string\"]},\"contactItem\":{\"operator\":\"NULL\",\"value\":[0]},\"contactUUID\":{\"operator\":\"NULL\",\"regexp\":\"string\",\"value\":[\"string\"]},\"executionId\":{\"operator\":\"NULL\",\"value\":[0]},\"listId\":{\"operator\":\"NULL\",\"value\":[0]},\"messageCloseTime\":{\"operator\":\"NULL\",\"value\":\"string\",\"valueLeft\":\"string\",\"valueRight\":\"string\"},\"messageFromNumber\":{\"operator\":\"NULL\",\"regexp\":\"string\",\"value\":[\"string\"]},\"messageId\":{\"operator\":\"NULL\",\"regexp\":\"string\",\"value\":[\"string\"]},\"messageInsertTime\":{\"operator\":\"NULL\",\"value\":\"string\",\"valueLeft\":\"string\",\"valueRight\":\"string\"},\"messageResult\":{\"operator\":\"NULL\",\"value\":[0]},\"messageToNumber\":{\"operator\":\"NULL\",\"regexp\":\"string\",\"value\":[\"string\"]},\"month\":0,\"year\":0},\"sorting\":{\"orderField\":\"MESSAGE_ID\",\"orderType\":\"ASC\"}}"
headers = {
'Content-Type': "application/json",
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("POST", "%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/messaging-history", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/messaging-history")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
request.body = "{\"pagination\":{\"pageNumber\":0,\"pageSize\":0},\"resultFields\":{},\"search\":{\"campaign\":{\"abilitation\":{\"description\":{\"operator\":null,\"regexp\":null,\"value\":null},\"enabled\":true,\"id\":{\"operator\":null,\"value\":null}},\"enabled\":true,\"id\":{\"operator\":\"NULL\",\"value\":[0]},\"list\":{\"id\":{\"operator\":null,\"value\":null},\"name\":{\"operator\":null,\"regexp\":null,\"value\":null}},\"name\":{\"operator\":\"NULL\",\"regexp\":\"string\",\"value\":[\"string\"]},\"openFrom\":{\"operator\":\"NULL\",\"value\":\"string\",\"valueLeft\":\"string\",\"valueRight\":\"string\"},\"openTo\":{\"operator\":\"NULL\",\"value\":\"string\",\"valueLeft\":\"string\",\"valueRight\":\"string\"},\"priority\":{\"operator\":\"NULL\",\"value\":[0]},\"service\":{\"code\":{\"operator\":null,\"regexp\":null,\"value\":null},\"description\":{\"operator\":null,\"regexp\":null,\"value\":null},\"serviceType\":[\"[\"]}},\"contactCustomId\":{\"operator\":\"NULL\",\"regexp\":\"string\",\"value\":[\"string\"]},\"contactItem\":{\"operator\":\"NULL\",\"value\":[0]},\"contactUUID\":{\"operator\":\"NULL\",\"regexp\":\"string\",\"value\":[\"string\"]},\"executionId\":{\"operator\":\"NULL\",\"value\":[0]},\"listId\":{\"operator\":\"NULL\",\"value\":[0]},\"messageCloseTime\":{\"operator\":\"NULL\",\"value\":\"string\",\"valueLeft\":\"string\",\"valueRight\":\"string\"},\"messageFromNumber\":{\"operator\":\"NULL\",\"regexp\":\"string\",\"value\":[\"string\"]},\"messageId\":{\"operator\":\"NULL\",\"regexp\":\"string\",\"value\":[\"string\"]},\"messageInsertTime\":{\"operator\":\"NULL\",\"value\":\"string\",\"valueLeft\":\"string\",\"valueRight\":\"string\"},\"messageResult\":{\"operator\":\"NULL\",\"value\":[0]},\"messageToNumber\":{\"operator\":\"NULL\",\"regexp\":\"string\",\"value\":[\"string\"]},\"month\":0,\"year\":0},\"sorting\":{\"orderField\":\"MESSAGE_ID\",\"orderType\":\"ASC\"}}"
response = http.request(request)
puts response.read_body
POST /rest/powerdialer/mc/messaging-history
Parameters
Body parameter
{
"pagination": {
"pageNumber": 0,
"pageSize": 0
},
"resultFields": {},
"search": {
"campaign": {
"abilitation": {
"description": {
"operator": null,
"regexp": null,
"value": null
},
"enabled": true,
"id": {
"operator": null,
"value": null
}
},
"enabled": true,
"id": {
"operator": "NULL",
"value": [
0
]
},
"list": {
"id": {
"operator": null,
"value": null
},
"name": {
"operator": null,
"regexp": null,
"value": null
}
},
"name": {
"operator": "NULL",
"regexp": "string",
"value": [
"string"
]
},
"openFrom": {
"operator": "NULL",
"value": "string",
"valueLeft": "string",
"valueRight": "string"
},
"openTo": {
"operator": "NULL",
"value": "string",
"valueLeft": "string",
"valueRight": "string"
},
"priority": {
"operator": "NULL",
"value": [
0
]
},
"service": {
"code": {
"operator": null,
"regexp": null,
"value": null
},
"description": {
"operator": null,
"regexp": null,
"value": null
},
"serviceType": [
"["
]
}
},
"contactCustomId": {
"operator": "NULL",
"regexp": "string",
"value": [
"string"
]
},
"contactItem": {
"operator": "NULL",
"value": [
0
]
},
"contactUUID": {
"operator": "NULL",
"regexp": "string",
"value": [
"string"
]
},
"executionId": {
"operator": "NULL",
"value": [
0
]
},
"listId": {
"operator": "NULL",
"value": [
0
]
},
"messageCloseTime": {
"operator": "NULL",
"value": "string",
"valueLeft": "string",
"valueRight": "string"
},
"messageFromNumber": {
"operator": "NULL",
"regexp": "string",
"value": [
"string"
]
},
"messageId": {
"operator": "NULL",
"regexp": "string",
"value": [
"string"
]
},
"messageInsertTime": {
"operator": "NULL",
"value": "string",
"valueLeft": "string",
"valueRight": "string"
},
"messageResult": {
"operator": "NULL",
"value": [
0
]
},
"messageToNumber": {
"operator": "NULL",
"regexp": "string",
"value": [
"string"
]
},
"month": 0,
"year": 0
},
"sorting": {
"orderField": "MESSAGE_ID",
"orderType": "ASC"
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | ReportSearchRequestObjectDatamodelSearchPowerDialerInstantMessagingHistoryDatamodelPowerDialerInstantMessagingHistorySortField | false | none |
Responses
Example responses
default Response
{
"__typename": "string",
"campaign": {
"SMSLimit": 0,
"SMSSequencePosition": 0,
"__typename": "string",
"abilitation": {
"__typename": "string",
"description": "string",
"enabled": true,
"id": 0
},
"enabled": true,
"id": 0,
"instantMessagingExternalAccountPhoneID": "string",
"instantMessagingLimit": 0,
"instantMessagingSequencePosition": 0,
"instantMessagingTemplate": "string",
"list": [
{
"__typename": "string",
"busy": {
"__typename": "string",
"attempts": 0,
"interval": 0
},
"cancel": {
"__typename": "string",
"attempts": 0,
"interval": 0
},
"congestion": {
"__typename": "string",
"attempts": 0,
"interval": 0
},
"id": 0,
"name": "string",
"noAnswer": {
"__typename": "string",
"attempts": 0,
"interval": 0
},
"tvoxClosed": {
"__typename": "string",
"attempts": 0,
"interval": 0
}
}
],
"mailLimit": 0,
"mailSequencePosition": 0,
"massiveMailLimit": 0,
"massiveMailSequencePosition": 0,
"massiveSMSLimit": 0,
"massiveSMSSequencePosition": 0,
"name": "string",
"openFrom": "string",
"openTo": "string",
"priority": 0,
"service": {
"__typename": "string",
"code": "string",
"description": "string"
}
},
"contactCustumId": "string",
"contactItem": 0,
"contactUUID": "string",
"executionId": 0,
"imCloseTime": "string",
"imConversationExpiration": "string",
"imConversationId": "string",
"imConversationOriginType": "string",
"imEntryId": "string",
"imInsertTime": "string",
"imLastUpdateTime": "string",
"imMetadataDisplayPhoneNumber": "string",
"imMetadataPhoneNumberId": "string",
"imRecipientId": "string",
"imStatus": "string",
"imWamId": "string",
"insertTime": "string",
"listId": 0,
"messageCloseTime": "string",
"messageFromNumber": "string",
"messageId": "string",
"messageInsertTime": "string",
"messageParam01": "string",
"messageParam02": "string",
"messageParam03": "string",
"messageParam04": "string",
"messageParam05": "string",
"messageParam06": "string",
"messageParam07": "string",
"messageParam08": "string",
"messageParam09": "string",
"messageParam10": "string",
"messageParam11": "string",
"messageParam12": "string",
"messageParam13": "string",
"messageParam14": "string",
"messageParam15": "string",
"messageParam16": "string",
"messageParam17": "string",
"messageParam18": "string",
"messageParam19": "string",
"messageParam20": "string",
"messageParam21": "string",
"messageParam22": "string",
"messageParam23": "string",
"messageParam24": "string",
"messageParam25": "string",
"messageParam26": "string",
"messageParam27": "string",
"messageParam28": "string",
"messageParam29": "string",
"messageParam30": "string",
"messageResult": 0,
"messageTemplate": "string",
"messageToNumber": "string"
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| default | Default | Get messaging history | [DatamodelPowerDialerInstantMessagingHistory] |
Delete one or more multichannel runs
Code samples
POST %3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/run HTTP/1.1
Content-Type: application/json
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
Content-Length: 3
[0]
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/run",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "[0]",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Content-Type: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request POST \
--url https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/run \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID' \
--data '[0]'
HttpResponse<String> response = Unirest.post("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/run")
.header("Content-Type", "application/json")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.body("[0]")
.asString();
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/run"
payload := strings.NewReader("[0]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = JSON.stringify([
0
]);
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("POST", "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/run");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "POST",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/run",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify([0]));
req.end();
import http.client
conn = http.client.HTTPSConnection("")
payload = "[0]"
headers = {
'Content-Type': "application/json",
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("POST", "%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/run", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/run")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
request.body = "[0]"
response = http.request(request)
puts response.read_body
POST /rest/powerdialer/mc/run
Parameters
Body parameter
[
0
]
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | [array[integer]] | true | List of Run IDs to delete |
Responses
Example responses
default Response
true
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| default | Default | Result of multichannel run deletion | boolean |
Create a multichannel run
Code samples
POST %3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/run/add HTTP/1.1
Content-Type: application/json
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
Content-Length: 627
{"campaignId":0,"contacts":[{"campaignId":0,"customFields":{"property1":"string","property2":"string"},"id":"string","itemContactType":"T4YOU","itemNumber":0,"templateLanguage":"IT","value":"string"}],"endDate":"2019-08-24T14:15:22Z","id":0,"instantMessagingEndDate":"2019-08-24T14:15:22Z","instantMessagingRunStatus":"DISABLE","instantMessagingStartDate":"2019-08-24T14:15:22Z","instantMessagingStatusDetail":"string","listId":0,"name":"string","number":"string","runStatus":"DISABLE","scheduledEndDate":"2019-08-24T14:15:22Z","scheduledStartDate":"2019-08-24T14:15:22Z","startDate":"2019-08-24T14:15:22Z","template":"string"}
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/run/add",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "{\"campaignId\":0,\"contacts\":[{\"campaignId\":0,\"customFields\":{\"property1\":\"string\",\"property2\":\"string\"},\"id\":\"string\",\"itemContactType\":\"T4YOU\",\"itemNumber\":0,\"templateLanguage\":\"IT\",\"value\":\"string\"}],\"endDate\":\"2019-08-24T14:15:22Z\",\"id\":0,\"instantMessagingEndDate\":\"2019-08-24T14:15:22Z\",\"instantMessagingRunStatus\":\"DISABLE\",\"instantMessagingStartDate\":\"2019-08-24T14:15:22Z\",\"instantMessagingStatusDetail\":\"string\",\"listId\":0,\"name\":\"string\",\"number\":\"string\",\"runStatus\":\"DISABLE\",\"scheduledEndDate\":\"2019-08-24T14:15:22Z\",\"scheduledStartDate\":\"2019-08-24T14:15:22Z\",\"startDate\":\"2019-08-24T14:15:22Z\",\"template\":\"string\"}",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Content-Type: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request POST \
--url https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/run/add \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID' \
--data '{"campaignId":0,"contacts":[{"campaignId":0,"customFields":{"property1":"string","property2":"string"},"id":"string","itemContactType":"T4YOU","itemNumber":0,"templateLanguage":"IT","value":"string"}],"endDate":"2019-08-24T14:15:22Z","id":0,"instantMessagingEndDate":"2019-08-24T14:15:22Z","instantMessagingRunStatus":"DISABLE","instantMessagingStartDate":"2019-08-24T14:15:22Z","instantMessagingStatusDetail":"string","listId":0,"name":"string","number":"string","runStatus":"DISABLE","scheduledEndDate":"2019-08-24T14:15:22Z","scheduledStartDate":"2019-08-24T14:15:22Z","startDate":"2019-08-24T14:15:22Z","template":"string"}'
HttpResponse<String> response = Unirest.post("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/run/add")
.header("Content-Type", "application/json")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.body("{\"campaignId\":0,\"contacts\":[{\"campaignId\":0,\"customFields\":{\"property1\":\"string\",\"property2\":\"string\"},\"id\":\"string\",\"itemContactType\":\"T4YOU\",\"itemNumber\":0,\"templateLanguage\":\"IT\",\"value\":\"string\"}],\"endDate\":\"2019-08-24T14:15:22Z\",\"id\":0,\"instantMessagingEndDate\":\"2019-08-24T14:15:22Z\",\"instantMessagingRunStatus\":\"DISABLE\",\"instantMessagingStartDate\":\"2019-08-24T14:15:22Z\",\"instantMessagingStatusDetail\":\"string\",\"listId\":0,\"name\":\"string\",\"number\":\"string\",\"runStatus\":\"DISABLE\",\"scheduledEndDate\":\"2019-08-24T14:15:22Z\",\"scheduledStartDate\":\"2019-08-24T14:15:22Z\",\"startDate\":\"2019-08-24T14:15:22Z\",\"template\":\"string\"}")
.asString();
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/run/add"
payload := strings.NewReader("{\"campaignId\":0,\"contacts\":[{\"campaignId\":0,\"customFields\":{\"property1\":\"string\",\"property2\":\"string\"},\"id\":\"string\",\"itemContactType\":\"T4YOU\",\"itemNumber\":0,\"templateLanguage\":\"IT\",\"value\":\"string\"}],\"endDate\":\"2019-08-24T14:15:22Z\",\"id\":0,\"instantMessagingEndDate\":\"2019-08-24T14:15:22Z\",\"instantMessagingRunStatus\":\"DISABLE\",\"instantMessagingStartDate\":\"2019-08-24T14:15:22Z\",\"instantMessagingStatusDetail\":\"string\",\"listId\":0,\"name\":\"string\",\"number\":\"string\",\"runStatus\":\"DISABLE\",\"scheduledEndDate\":\"2019-08-24T14:15:22Z\",\"scheduledStartDate\":\"2019-08-24T14:15:22Z\",\"startDate\":\"2019-08-24T14:15:22Z\",\"template\":\"string\"}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = JSON.stringify({
"campaignId": 0,
"contacts": [
{
"campaignId": 0,
"customFields": {
"property1": "string",
"property2": "string"
},
"id": "string",
"itemContactType": "T4YOU",
"itemNumber": 0,
"templateLanguage": "IT",
"value": "string"
}
],
"endDate": "2019-08-24T14:15:22Z",
"id": 0,
"instantMessagingEndDate": "2019-08-24T14:15:22Z",
"instantMessagingRunStatus": "DISABLE",
"instantMessagingStartDate": "2019-08-24T14:15:22Z",
"instantMessagingStatusDetail": "string",
"listId": 0,
"name": "string",
"number": "string",
"runStatus": "DISABLE",
"scheduledEndDate": "2019-08-24T14:15:22Z",
"scheduledStartDate": "2019-08-24T14:15:22Z",
"startDate": "2019-08-24T14:15:22Z",
"template": "string"
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("POST", "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/run/add");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "POST",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/run/add",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
campaignId: 0,
contacts: [
{
campaignId: 0,
customFields: {property1: 'string', property2: 'string'},
id: 'string',
itemContactType: 'T4YOU',
itemNumber: 0,
templateLanguage: 'IT',
value: 'string'
}
],
endDate: '2019-08-24T14:15:22Z',
id: 0,
instantMessagingEndDate: '2019-08-24T14:15:22Z',
instantMessagingRunStatus: 'DISABLE',
instantMessagingStartDate: '2019-08-24T14:15:22Z',
instantMessagingStatusDetail: 'string',
listId: 0,
name: 'string',
number: 'string',
runStatus: 'DISABLE',
scheduledEndDate: '2019-08-24T14:15:22Z',
scheduledStartDate: '2019-08-24T14:15:22Z',
startDate: '2019-08-24T14:15:22Z',
template: 'string'
}));
req.end();
import http.client
conn = http.client.HTTPSConnection("")
payload = "{\"campaignId\":0,\"contacts\":[{\"campaignId\":0,\"customFields\":{\"property1\":\"string\",\"property2\":\"string\"},\"id\":\"string\",\"itemContactType\":\"T4YOU\",\"itemNumber\":0,\"templateLanguage\":\"IT\",\"value\":\"string\"}],\"endDate\":\"2019-08-24T14:15:22Z\",\"id\":0,\"instantMessagingEndDate\":\"2019-08-24T14:15:22Z\",\"instantMessagingRunStatus\":\"DISABLE\",\"instantMessagingStartDate\":\"2019-08-24T14:15:22Z\",\"instantMessagingStatusDetail\":\"string\",\"listId\":0,\"name\":\"string\",\"number\":\"string\",\"runStatus\":\"DISABLE\",\"scheduledEndDate\":\"2019-08-24T14:15:22Z\",\"scheduledStartDate\":\"2019-08-24T14:15:22Z\",\"startDate\":\"2019-08-24T14:15:22Z\",\"template\":\"string\"}"
headers = {
'Content-Type': "application/json",
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("POST", "%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/run/add", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/run/add")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
request.body = "{\"campaignId\":0,\"contacts\":[{\"campaignId\":0,\"customFields\":{\"property1\":\"string\",\"property2\":\"string\"},\"id\":\"string\",\"itemContactType\":\"T4YOU\",\"itemNumber\":0,\"templateLanguage\":\"IT\",\"value\":\"string\"}],\"endDate\":\"2019-08-24T14:15:22Z\",\"id\":0,\"instantMessagingEndDate\":\"2019-08-24T14:15:22Z\",\"instantMessagingRunStatus\":\"DISABLE\",\"instantMessagingStartDate\":\"2019-08-24T14:15:22Z\",\"instantMessagingStatusDetail\":\"string\",\"listId\":0,\"name\":\"string\",\"number\":\"string\",\"runStatus\":\"DISABLE\",\"scheduledEndDate\":\"2019-08-24T14:15:22Z\",\"scheduledStartDate\":\"2019-08-24T14:15:22Z\",\"startDate\":\"2019-08-24T14:15:22Z\",\"template\":\"string\"}"
response = http.request(request)
puts response.read_body
POST /rest/powerdialer/mc/run/add
Parameters
Body parameter
{
"campaignId": 0,
"contacts": [
{
"campaignId": 0,
"customFields": {
"property1": "string",
"property2": "string"
},
"id": "string",
"itemContactType": "T4YOU",
"itemNumber": 0,
"templateLanguage": "IT",
"value": "string"
}
],
"endDate": "2019-08-24T14:15:22Z",
"id": 0,
"instantMessagingEndDate": "2019-08-24T14:15:22Z",
"instantMessagingRunStatus": "DISABLE",
"instantMessagingStartDate": "2019-08-24T14:15:22Z",
"instantMessagingStatusDetail": "string",
"listId": 0,
"name": "string",
"number": "string",
"runStatus": "DISABLE",
"scheduledEndDate": "2019-08-24T14:15:22Z",
"scheduledStartDate": "2019-08-24T14:15:22Z",
"startDate": "2019-08-24T14:15:22Z",
"template": "string"
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | PDCampaignRun | true | none |
Responses
Example responses
default Response
{
"campaignId": 0,
"contacts": [
{
"campaignId": 0,
"customFields": {
"property1": "string",
"property2": "string"
},
"id": "string",
"itemContactType": "T4YOU",
"itemNumber": 0,
"templateLanguage": "IT",
"value": "string"
}
],
"endDate": "2019-08-24T14:15:22Z",
"id": 0,
"instantMessagingEndDate": "2019-08-24T14:15:22Z",
"instantMessagingRunStatus": "DISABLE",
"instantMessagingStartDate": "2019-08-24T14:15:22Z",
"instantMessagingStatusDetail": "string",
"listId": 0,
"name": "string",
"number": "string",
"runStatus": "DISABLE",
"scheduledEndDate": "2019-08-24T14:15:22Z",
"scheduledStartDate": "2019-08-24T14:15:22Z",
"startDate": "2019-08-24T14:15:22Z",
"template": "string"
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| default | Default | Created multichannel run | PDCampaignRun |
Update a multichannel run
Code samples
POST %3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/run/edit HTTP/1.1
Content-Type: application/json
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
Content-Length: 627
{"campaignId":0,"contacts":[{"campaignId":0,"customFields":{"property1":"string","property2":"string"},"id":"string","itemContactType":"T4YOU","itemNumber":0,"templateLanguage":"IT","value":"string"}],"endDate":"2019-08-24T14:15:22Z","id":0,"instantMessagingEndDate":"2019-08-24T14:15:22Z","instantMessagingRunStatus":"DISABLE","instantMessagingStartDate":"2019-08-24T14:15:22Z","instantMessagingStatusDetail":"string","listId":0,"name":"string","number":"string","runStatus":"DISABLE","scheduledEndDate":"2019-08-24T14:15:22Z","scheduledStartDate":"2019-08-24T14:15:22Z","startDate":"2019-08-24T14:15:22Z","template":"string"}
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/run/edit",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "{\"campaignId\":0,\"contacts\":[{\"campaignId\":0,\"customFields\":{\"property1\":\"string\",\"property2\":\"string\"},\"id\":\"string\",\"itemContactType\":\"T4YOU\",\"itemNumber\":0,\"templateLanguage\":\"IT\",\"value\":\"string\"}],\"endDate\":\"2019-08-24T14:15:22Z\",\"id\":0,\"instantMessagingEndDate\":\"2019-08-24T14:15:22Z\",\"instantMessagingRunStatus\":\"DISABLE\",\"instantMessagingStartDate\":\"2019-08-24T14:15:22Z\",\"instantMessagingStatusDetail\":\"string\",\"listId\":0,\"name\":\"string\",\"number\":\"string\",\"runStatus\":\"DISABLE\",\"scheduledEndDate\":\"2019-08-24T14:15:22Z\",\"scheduledStartDate\":\"2019-08-24T14:15:22Z\",\"startDate\":\"2019-08-24T14:15:22Z\",\"template\":\"string\"}",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Content-Type: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request POST \
--url https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/run/edit \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID' \
--data '{"campaignId":0,"contacts":[{"campaignId":0,"customFields":{"property1":"string","property2":"string"},"id":"string","itemContactType":"T4YOU","itemNumber":0,"templateLanguage":"IT","value":"string"}],"endDate":"2019-08-24T14:15:22Z","id":0,"instantMessagingEndDate":"2019-08-24T14:15:22Z","instantMessagingRunStatus":"DISABLE","instantMessagingStartDate":"2019-08-24T14:15:22Z","instantMessagingStatusDetail":"string","listId":0,"name":"string","number":"string","runStatus":"DISABLE","scheduledEndDate":"2019-08-24T14:15:22Z","scheduledStartDate":"2019-08-24T14:15:22Z","startDate":"2019-08-24T14:15:22Z","template":"string"}'
HttpResponse<String> response = Unirest.post("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/run/edit")
.header("Content-Type", "application/json")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.body("{\"campaignId\":0,\"contacts\":[{\"campaignId\":0,\"customFields\":{\"property1\":\"string\",\"property2\":\"string\"},\"id\":\"string\",\"itemContactType\":\"T4YOU\",\"itemNumber\":0,\"templateLanguage\":\"IT\",\"value\":\"string\"}],\"endDate\":\"2019-08-24T14:15:22Z\",\"id\":0,\"instantMessagingEndDate\":\"2019-08-24T14:15:22Z\",\"instantMessagingRunStatus\":\"DISABLE\",\"instantMessagingStartDate\":\"2019-08-24T14:15:22Z\",\"instantMessagingStatusDetail\":\"string\",\"listId\":0,\"name\":\"string\",\"number\":\"string\",\"runStatus\":\"DISABLE\",\"scheduledEndDate\":\"2019-08-24T14:15:22Z\",\"scheduledStartDate\":\"2019-08-24T14:15:22Z\",\"startDate\":\"2019-08-24T14:15:22Z\",\"template\":\"string\"}")
.asString();
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/run/edit"
payload := strings.NewReader("{\"campaignId\":0,\"contacts\":[{\"campaignId\":0,\"customFields\":{\"property1\":\"string\",\"property2\":\"string\"},\"id\":\"string\",\"itemContactType\":\"T4YOU\",\"itemNumber\":0,\"templateLanguage\":\"IT\",\"value\":\"string\"}],\"endDate\":\"2019-08-24T14:15:22Z\",\"id\":0,\"instantMessagingEndDate\":\"2019-08-24T14:15:22Z\",\"instantMessagingRunStatus\":\"DISABLE\",\"instantMessagingStartDate\":\"2019-08-24T14:15:22Z\",\"instantMessagingStatusDetail\":\"string\",\"listId\":0,\"name\":\"string\",\"number\":\"string\",\"runStatus\":\"DISABLE\",\"scheduledEndDate\":\"2019-08-24T14:15:22Z\",\"scheduledStartDate\":\"2019-08-24T14:15:22Z\",\"startDate\":\"2019-08-24T14:15:22Z\",\"template\":\"string\"}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = JSON.stringify({
"campaignId": 0,
"contacts": [
{
"campaignId": 0,
"customFields": {
"property1": "string",
"property2": "string"
},
"id": "string",
"itemContactType": "T4YOU",
"itemNumber": 0,
"templateLanguage": "IT",
"value": "string"
}
],
"endDate": "2019-08-24T14:15:22Z",
"id": 0,
"instantMessagingEndDate": "2019-08-24T14:15:22Z",
"instantMessagingRunStatus": "DISABLE",
"instantMessagingStartDate": "2019-08-24T14:15:22Z",
"instantMessagingStatusDetail": "string",
"listId": 0,
"name": "string",
"number": "string",
"runStatus": "DISABLE",
"scheduledEndDate": "2019-08-24T14:15:22Z",
"scheduledStartDate": "2019-08-24T14:15:22Z",
"startDate": "2019-08-24T14:15:22Z",
"template": "string"
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("POST", "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/run/edit");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "POST",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/run/edit",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
campaignId: 0,
contacts: [
{
campaignId: 0,
customFields: {property1: 'string', property2: 'string'},
id: 'string',
itemContactType: 'T4YOU',
itemNumber: 0,
templateLanguage: 'IT',
value: 'string'
}
],
endDate: '2019-08-24T14:15:22Z',
id: 0,
instantMessagingEndDate: '2019-08-24T14:15:22Z',
instantMessagingRunStatus: 'DISABLE',
instantMessagingStartDate: '2019-08-24T14:15:22Z',
instantMessagingStatusDetail: 'string',
listId: 0,
name: 'string',
number: 'string',
runStatus: 'DISABLE',
scheduledEndDate: '2019-08-24T14:15:22Z',
scheduledStartDate: '2019-08-24T14:15:22Z',
startDate: '2019-08-24T14:15:22Z',
template: 'string'
}));
req.end();
import http.client
conn = http.client.HTTPSConnection("")
payload = "{\"campaignId\":0,\"contacts\":[{\"campaignId\":0,\"customFields\":{\"property1\":\"string\",\"property2\":\"string\"},\"id\":\"string\",\"itemContactType\":\"T4YOU\",\"itemNumber\":0,\"templateLanguage\":\"IT\",\"value\":\"string\"}],\"endDate\":\"2019-08-24T14:15:22Z\",\"id\":0,\"instantMessagingEndDate\":\"2019-08-24T14:15:22Z\",\"instantMessagingRunStatus\":\"DISABLE\",\"instantMessagingStartDate\":\"2019-08-24T14:15:22Z\",\"instantMessagingStatusDetail\":\"string\",\"listId\":0,\"name\":\"string\",\"number\":\"string\",\"runStatus\":\"DISABLE\",\"scheduledEndDate\":\"2019-08-24T14:15:22Z\",\"scheduledStartDate\":\"2019-08-24T14:15:22Z\",\"startDate\":\"2019-08-24T14:15:22Z\",\"template\":\"string\"}"
headers = {
'Content-Type': "application/json",
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("POST", "%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/run/edit", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/run/edit")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
request.body = "{\"campaignId\":0,\"contacts\":[{\"campaignId\":0,\"customFields\":{\"property1\":\"string\",\"property2\":\"string\"},\"id\":\"string\",\"itemContactType\":\"T4YOU\",\"itemNumber\":0,\"templateLanguage\":\"IT\",\"value\":\"string\"}],\"endDate\":\"2019-08-24T14:15:22Z\",\"id\":0,\"instantMessagingEndDate\":\"2019-08-24T14:15:22Z\",\"instantMessagingRunStatus\":\"DISABLE\",\"instantMessagingStartDate\":\"2019-08-24T14:15:22Z\",\"instantMessagingStatusDetail\":\"string\",\"listId\":0,\"name\":\"string\",\"number\":\"string\",\"runStatus\":\"DISABLE\",\"scheduledEndDate\":\"2019-08-24T14:15:22Z\",\"scheduledStartDate\":\"2019-08-24T14:15:22Z\",\"startDate\":\"2019-08-24T14:15:22Z\",\"template\":\"string\"}"
response = http.request(request)
puts response.read_body
POST /rest/powerdialer/mc/run/edit
Parameters
Body parameter
{
"campaignId": 0,
"contacts": [
{
"campaignId": 0,
"customFields": {
"property1": "string",
"property2": "string"
},
"id": "string",
"itemContactType": "T4YOU",
"itemNumber": 0,
"templateLanguage": "IT",
"value": "string"
}
],
"endDate": "2019-08-24T14:15:22Z",
"id": 0,
"instantMessagingEndDate": "2019-08-24T14:15:22Z",
"instantMessagingRunStatus": "DISABLE",
"instantMessagingStartDate": "2019-08-24T14:15:22Z",
"instantMessagingStatusDetail": "string",
"listId": 0,
"name": "string",
"number": "string",
"runStatus": "DISABLE",
"scheduledEndDate": "2019-08-24T14:15:22Z",
"scheduledStartDate": "2019-08-24T14:15:22Z",
"startDate": "2019-08-24T14:15:22Z",
"template": "string"
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | PDCampaignRun | true | none |
Responses
Example responses
default Response
{
"campaignId": 0,
"contacts": [
{
"campaignId": 0,
"customFields": {
"property1": "string",
"property2": "string"
},
"id": "string",
"itemContactType": "T4YOU",
"itemNumber": 0,
"templateLanguage": "IT",
"value": "string"
}
],
"endDate": "2019-08-24T14:15:22Z",
"id": 0,
"instantMessagingEndDate": "2019-08-24T14:15:22Z",
"instantMessagingRunStatus": "DISABLE",
"instantMessagingStartDate": "2019-08-24T14:15:22Z",
"instantMessagingStatusDetail": "string",
"listId": 0,
"name": "string",
"number": "string",
"runStatus": "DISABLE",
"scheduledEndDate": "2019-08-24T14:15:22Z",
"scheduledStartDate": "2019-08-24T14:15:22Z",
"startDate": "2019-08-24T14:15:22Z",
"template": "string"
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| default | Default | Updated multichannel run | PDCampaignRun |
Get multichannel run from campaign id and run name
Code samples
GET %3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/run/0/string HTTP/1.1
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/run/0/string",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request GET \
--url https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/run/0/string \
--header 'Accept: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID'
HttpResponse<String> response = Unirest.get("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/run/0/string")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.asString();
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/run/0/string"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("GET", "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/run/0/string");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "GET",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/run/0/string",
"headers": {
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
import http.client
conn = http.client.HTTPSConnection("")
headers = {
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("GET", "%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/run/0/string", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/run/0/string")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
response = http.request(request)
puts response.read_body
GET /rest/powerdialer/mc/run/{campaignId}/{runName}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| campaignId | path | integer(int32) | true | none |
| runName | path | string | true | none |
Responses
Example responses
default Response
{
"campaignId": 0,
"contacts": [
{
"campaignId": 0,
"customFields": {
"property1": "string",
"property2": "string"
},
"id": "string",
"itemContactType": "T4YOU",
"itemNumber": 0,
"templateLanguage": "IT",
"value": "string"
}
],
"endDate": "2019-08-24T14:15:22Z",
"id": 0,
"instantMessagingEndDate": "2019-08-24T14:15:22Z",
"instantMessagingRunStatus": "DISABLE",
"instantMessagingStartDate": "2019-08-24T14:15:22Z",
"instantMessagingStatusDetail": "string",
"listId": 0,
"name": "string",
"number": "string",
"runStatus": "DISABLE",
"scheduledEndDate": "2019-08-24T14:15:22Z",
"scheduledStartDate": "2019-08-24T14:15:22Z",
"startDate": "2019-08-24T14:15:22Z",
"template": "string"
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| default | Default | Get multichannel run from campaign id and run name | PDCampaignRun |
Get a multichannel run
Code samples
GET %3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/run/0 HTTP/1.1
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/run/0",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request GET \
--url https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/run/0 \
--header 'Accept: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID'
HttpResponse<String> response = Unirest.get("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/run/0")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.asString();
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/run/0"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("GET", "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/run/0");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "GET",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/run/0",
"headers": {
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
import http.client
conn = http.client.HTTPSConnection("")
headers = {
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("GET", "%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/run/0", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/run/0")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
response = http.request(request)
puts response.read_body
GET /rest/powerdialer/mc/run/{campaignRunId}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| campaignRunId | path | integer(int32) | true | none |
| instantMessagingEndDate | query | string(date-time) | false | none |
Responses
Example responses
default Response
{
"campaignId": 0,
"contacts": [
{
"campaignId": 0,
"customFields": {
"property1": "string",
"property2": "string"
},
"id": "string",
"itemContactType": "T4YOU",
"itemNumber": 0,
"templateLanguage": "IT",
"value": "string"
}
],
"endDate": "2019-08-24T14:15:22Z",
"id": 0,
"instantMessagingEndDate": "2019-08-24T14:15:22Z",
"instantMessagingRunStatus": "DISABLE",
"instantMessagingStartDate": "2019-08-24T14:15:22Z",
"instantMessagingStatusDetail": "string",
"listId": 0,
"name": "string",
"number": "string",
"runStatus": "DISABLE",
"scheduledEndDate": "2019-08-24T14:15:22Z",
"scheduledStartDate": "2019-08-24T14:15:22Z",
"startDate": "2019-08-24T14:15:22Z",
"template": "string"
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| default | Default | Get multichannel run | PDCampaignRun |
Retrieve configured WhatsApp templates
Code samples
POST %3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/whatsapp-templates HTTP/1.1
Content-Type: application/json
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
Content-Length: 73
{"apiKey":"string","limit":0,"number":"string","offset":0,"sid":"string"}
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/whatsapp-templates",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "{\"apiKey\":\"string\",\"limit\":0,\"number\":\"string\",\"offset\":0,\"sid\":\"string\"}",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Content-Type: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request POST \
--url https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/whatsapp-templates \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID' \
--data '{"apiKey":"string","limit":0,"number":"string","offset":0,"sid":"string"}'
HttpResponse<String> response = Unirest.post("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/whatsapp-templates")
.header("Content-Type", "application/json")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.body("{\"apiKey\":\"string\",\"limit\":0,\"number\":\"string\",\"offset\":0,\"sid\":\"string\"}")
.asString();
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/whatsapp-templates"
payload := strings.NewReader("{\"apiKey\":\"string\",\"limit\":0,\"number\":\"string\",\"offset\":0,\"sid\":\"string\"}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = JSON.stringify({
"apiKey": "string",
"limit": 0,
"number": "string",
"offset": 0,
"sid": "string"
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("POST", "https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/whatsapp-templates");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "POST",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/whatsapp-templates",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({apiKey: 'string', limit: 0, number: 'string', offset: 0, sid: 'string'}));
req.end();
import http.client
conn = http.client.HTTPSConnection("")
payload = "{\"apiKey\":\"string\",\"limit\":0,\"number\":\"string\",\"offset\":0,\"sid\":\"string\"}"
headers = {
'Content-Type': "application/json",
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("POST", "%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/whatsapp-templates", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/powerdialer/mc/whatsapp-templates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
request.body = "{\"apiKey\":\"string\",\"limit\":0,\"number\":\"string\",\"offset\":0,\"sid\":\"string\"}"
response = http.request(request)
puts response.read_body
POST /rest/powerdialer/mc/whatsapp-templates
Returns the list of WhatsApp message templates configured for the specified Kaleyra account.
Parameters
Body parameter
{
"apiKey": "string",
"limit": 0,
"number": "string",
"offset": 0,
"sid": "string"
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | WhatsAppTemplateListRequest | true | Request payload containing Kaleyra account credentials and filtering parameters |
Responses
Example responses
default Response
{
"code": "string",
"data": [
{
"category": "string",
"category_change": "string",
"components": [
{
"text": "string",
"type": "string"
}
],
"language": "string",
"name": "string",
"status": "string",
"waba_id": "string"
}
],
"message": "string",
"total": 0
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 400 | Bad Request | Invalid request payload or missing parameters | None |
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| 500 | Internal Server Error | Internal server error while retrieving templates | None |
| default | Default | Successfully retrieved the configured WhatsApp templates | TemplatesInformation |
SMS
SMS utils
Send SMS
Code samples
POST %3CTVOX_HOST%3E/tvox/rest/sms/send HTTP/1.1
Content-Type: application/json
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
Content-Length: 77
{"accountId":0,"message":"string","phoneNumber":"string","username":"string"}
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/sms/send",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "{\"accountId\":0,\"message\":\"string\",\"phoneNumber\":\"string\",\"username\":\"string\"}",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Content-Type: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request POST \
--url https:///%3CTVOX_HOST%3E/tvox/rest/sms/send \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID' \
--data '{"accountId":0,"message":"string","phoneNumber":"string","username":"string"}'
HttpResponse<String> response = Unirest.post("https:///%3CTVOX_HOST%3E/tvox/rest/sms/send")
.header("Content-Type", "application/json")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.body("{\"accountId\":0,\"message\":\"string\",\"phoneNumber\":\"string\",\"username\":\"string\"}")
.asString();
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/sms/send"
payload := strings.NewReader("{\"accountId\":0,\"message\":\"string\",\"phoneNumber\":\"string\",\"username\":\"string\"}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = JSON.stringify({
"accountId": 0,
"message": "string",
"phoneNumber": "string",
"username": "string"
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("POST", "https:///%3CTVOX_HOST%3E/tvox/rest/sms/send");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "POST",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/sms/send",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({accountId: 0, message: 'string', phoneNumber: 'string', username: 'string'}));
req.end();
import http.client
conn = http.client.HTTPSConnection("")
payload = "{\"accountId\":0,\"message\":\"string\",\"phoneNumber\":\"string\",\"username\":\"string\"}"
headers = {
'Content-Type': "application/json",
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("POST", "%3CTVOX_HOST%3E/tvox/rest/sms/send", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/sms/send")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
request.body = "{\"accountId\":0,\"message\":\"string\",\"phoneNumber\":\"string\",\"username\":\"string\"}"
response = http.request(request)
puts response.read_body
POST /rest/sms/send
Send SMS from specific enabled user to any number. You can specify SMS account id in case of multi-account configuration
Parameters
Body parameter
{
"accountId": 0,
"message": "string",
"phoneNumber": "string",
"username": "string"
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | SmsSendRequest | false | none |
Responses
Example responses
default Response
true
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| 404 | Not Found | Error: Object was not found. | GenericObjectWasNotFoundException |
| 412 | Precondition Failed | Error: Object required. A required field is missing or empty | GenericObjectRequiredException |
| 570 | Unknown | Error: Operation is NOT allowed to user | OperationIsNotAllowedToUserProfileException |
| default | Default | SMS sent | boolean |
Support channel - Ticket
Support channel - Ticket management
List agents
Code samples
GET %3CTVOX_HOST%3E/tvox/rest/support/ticket/agent/list HTTP/1.1
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/agent/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request GET \
--url https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/agent/list \
--header 'Accept: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID'
HttpResponse<String> response = Unirest.get("https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/agent/list")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.asString();
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/agent/list"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("GET", "https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/agent/list");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "GET",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/support/ticket/agent/list",
"headers": {
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
import http.client
conn = http.client.HTTPSConnection("")
headers = {
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("GET", "%3CTVOX_HOST%3E/tvox/rest/support/ticket/agent/list", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/agent/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
response = http.request(request)
puts response.read_body
GET /rest/support/ticket/agent/list
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| searchKey | query | string | false | none |
| index | query | integer(int32) | false | none |
| size | query | integer(int32) | false | none |
| services | query | string | false | none |
Responses
Example responses
default Response
{
"result": [
{
"displayName": "string",
"email": "string",
"language": "IT",
"name": "string",
"publicUsername": "string",
"serviceCodes": [
"string"
],
"surname": "string",
"type": "USER",
"uid": "string",
"userIdMc1002": 0,
"username": "string",
"value": "string"
}
],
"tot": 0
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| default | Default | List agents | SearchResultContactIdentifierWithUserInformations |
List customers
Code samples
GET %3CTVOX_HOST%3E/tvox/rest/support/ticket/customer/list HTTP/1.1
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/customer/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request GET \
--url https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/customer/list \
--header 'Accept: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID'
HttpResponse<String> response = Unirest.get("https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/customer/list")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.asString();
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/customer/list"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("GET", "https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/customer/list");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "GET",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/support/ticket/customer/list",
"headers": {
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
import http.client
conn = http.client.HTTPSConnection("")
headers = {
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("GET", "%3CTVOX_HOST%3E/tvox/rest/support/ticket/customer/list", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/customer/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
response = http.request(request)
puts response.read_body
GET /rest/support/ticket/customer/list
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| searchKey | query | string | false | none |
| index | query | integer(int32) | false | none |
| size | query | integer(int32) | false | none |
Responses
Example responses
default Response
{
"result": [
{
"displayName": "string",
"email": "string",
"language": "IT",
"name": "string",
"publicUsername": "string",
"serviceCodes": [
"string"
],
"surname": "string",
"type": "USER",
"uid": "string",
"userIdMc1002": 0,
"username": "string",
"value": "string"
}
],
"tot": 0
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| default | Default | List customers | SearchResultContactIdentifierWithUserInformations |
Search tickets
Code samples
POST %3CTVOX_HOST%3E/tvox/rest/support/ticket/search HTTP/1.1
Content-Type: application/json
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
Content-Length: 222
{"context":"IVR","customFields":{"property1":["string"],"property2":["string"]},"customerId":["string"],"ownerId":["string"],"pageNumber":0,"pageSize":0,"serviceCode":["string"],"stateId":["string"],"submitterId":"string"}
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "{\"context\":\"IVR\",\"customFields\":{\"property1\":[\"string\"],\"property2\":[\"string\"]},\"customerId\":[\"string\"],\"ownerId\":[\"string\"],\"pageNumber\":0,\"pageSize\":0,\"serviceCode\":[\"string\"],\"stateId\":[\"string\"],\"submitterId\":\"string\"}",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Content-Type: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request POST \
--url https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/search \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID' \
--data '{"context":"IVR","customFields":{"property1":["string"],"property2":["string"]},"customerId":["string"],"ownerId":["string"],"pageNumber":0,"pageSize":0,"serviceCode":["string"],"stateId":["string"],"submitterId":"string"}'
HttpResponse<String> response = Unirest.post("https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/search")
.header("Content-Type", "application/json")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.body("{\"context\":\"IVR\",\"customFields\":{\"property1\":[\"string\"],\"property2\":[\"string\"]},\"customerId\":[\"string\"],\"ownerId\":[\"string\"],\"pageNumber\":0,\"pageSize\":0,\"serviceCode\":[\"string\"],\"stateId\":[\"string\"],\"submitterId\":\"string\"}")
.asString();
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/search"
payload := strings.NewReader("{\"context\":\"IVR\",\"customFields\":{\"property1\":[\"string\"],\"property2\":[\"string\"]},\"customerId\":[\"string\"],\"ownerId\":[\"string\"],\"pageNumber\":0,\"pageSize\":0,\"serviceCode\":[\"string\"],\"stateId\":[\"string\"],\"submitterId\":\"string\"}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = JSON.stringify({
"context": "IVR",
"customFields": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"customerId": [
"string"
],
"ownerId": [
"string"
],
"pageNumber": 0,
"pageSize": 0,
"serviceCode": [
"string"
],
"stateId": [
"string"
],
"submitterId": "string"
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("POST", "https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/search");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "POST",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/support/ticket/search",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
context: 'IVR',
customFields: {property1: ['string'], property2: ['string']},
customerId: ['string'],
ownerId: ['string'],
pageNumber: 0,
pageSize: 0,
serviceCode: ['string'],
stateId: ['string'],
submitterId: 'string'
}));
req.end();
import http.client
conn = http.client.HTTPSConnection("")
payload = "{\"context\":\"IVR\",\"customFields\":{\"property1\":[\"string\"],\"property2\":[\"string\"]},\"customerId\":[\"string\"],\"ownerId\":[\"string\"],\"pageNumber\":0,\"pageSize\":0,\"serviceCode\":[\"string\"],\"stateId\":[\"string\"],\"submitterId\":\"string\"}"
headers = {
'Content-Type': "application/json",
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("POST", "%3CTVOX_HOST%3E/tvox/rest/support/ticket/search", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
request.body = "{\"context\":\"IVR\",\"customFields\":{\"property1\":[\"string\"],\"property2\":[\"string\"]},\"customerId\":[\"string\"],\"ownerId\":[\"string\"],\"pageNumber\":0,\"pageSize\":0,\"serviceCode\":[\"string\"],\"stateId\":[\"string\"],\"submitterId\":\"string\"}"
response = http.request(request)
puts response.read_body
POST /rest/support/ticket/search
Request to search tickets
Parameters
Body parameter
{
"context": "IVR",
"customFields": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"customerId": [
"string"
],
"ownerId": [
"string"
],
"pageNumber": 0,
"pageSize": 0,
"serviceCode": [
"string"
],
"stateId": [
"string"
],
"submitterId": "string"
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | TicketSearchRequest | true | Request to search tickets |
Responses
Example responses
default Response
{
"article": {
"attachments": [
{
"data": "string",
"filename": "string",
"id": 0,
"mime-type": "string",
"preferences": {
"property1": "string",
"property2": "string"
},
"size": "string"
}
],
"body": "string",
"cc": "string",
"content_type": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"created_by_id": 0,
"from": "string",
"id": 0,
"in_reply_to": "string",
"internal": true,
"message_id": "string",
"message_id_md5": "string",
"origin_by": "string",
"origin_by_id": 0,
"preferences": {
"property1": {},
"property2": {}
},
"references": "string",
"reply_to": "string",
"sender": "Agent",
"sender_id": 0,
"subject": "string",
"ticket_id": 0,
"time_unit": 0,
"to": "string",
"type": "email",
"type_id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"updated_by": "string",
"updated_by_id": 0
},
"article_count": 0,
"article_ids": [
0
],
"articles": [
{
"attachments": [
{
"data": "string",
"filename": "string",
"id": 0,
"mime-type": "string",
"preferences": {
"property1": "string",
"property2": "string"
},
"size": "string"
}
],
"body": "string",
"cc": "string",
"content_type": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"created_by_id": 0,
"from": "string",
"id": 0,
"in_reply_to": "string",
"internal": true,
"message_id": "string",
"message_id_md5": "string",
"origin_by": "string",
"origin_by_id": 0,
"preferences": {
"property1": {},
"property2": {}
},
"references": "string",
"reply_to": "string",
"sender": "Agent",
"sender_id": 0,
"subject": "string",
"ticket_id": 0,
"time_unit": 0,
"to": "string",
"type": "email",
"type_id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"updated_by": "string",
"updated_by_id": 0
}
],
"attachments": [
{
"mimeType": "string",
"name": "string",
"uuid": "string"
}
],
"close_at": "2019-08-24T14:15:22Z",
"close_diff_in_min": 0,
"close_escalation_at": "2019-08-24T14:15:22Z",
"close_in_min": 0,
"create_article_sender": "string",
"create_article_sender_id": 0,
"create_article_type": "string",
"create_article_type_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"created_by_id": 0,
"customer": "string",
"customerContact": {
"type": "USER",
"uid": "string",
"username": "string",
"value": "string"
},
"customer_id": "string",
"escalation_at": "2019-08-24T14:15:22Z",
"first_response_at": "2019-08-24T14:15:22Z",
"first_response_diff_in_min": 0,
"first_response_escalation_at": "2019-08-24T14:15:22Z",
"first_response_in_min": 0,
"group": "string",
"group_id": 0,
"id": 0,
"last_contact_agent_at": "2019-08-24T14:15:22Z",
"last_contact_at": "2019-08-24T14:15:22Z",
"last_contact_customer_at": "2019-08-24T14:15:22Z",
"last_owner_update_at": "2019-08-24T14:15:22Z",
"note": "string",
"number": "string",
"organization": "string",
"organization_id": 0,
"owner": "string",
"ownerContact": {
"type": "USER",
"uid": "string",
"username": "string",
"value": "string"
},
"owner_id": 0,
"pending_time": "2019-08-24T14:15:22Z",
"priority": "1 low",
"priority_id": 0,
"state": "new",
"state_id": 0,
"t_agent_close_date": "2019-08-24T14:15:22Z",
"t_agent_get_date": "2019-08-24T14:15:22Z",
"t_call_link": "string",
"t_create_call_uid": "string",
"t_custom_01": "string",
"t_custom_02": "string",
"t_custom_03": "string",
"t_custom_04": "string",
"t_custom_05": "string",
"t_custom_06": "string",
"t_custom_07": "string",
"t_custom_08": "string",
"t_custom_09": "string",
"t_custom_10": "string",
"t_custom_11": "string",
"t_custom_12": "string",
"t_custom_13": "string",
"t_custom_14": "string",
"t_custom_15": "string",
"t_custom_16": "string",
"t_custom_17": "string",
"t_custom_18": "string",
"t_custom_19": "string",
"t_custom_20": "string",
"t_custom_21": "string",
"t_custom_22": "string",
"t_custom_23": "string",
"t_custom_24": "string",
"t_custom_25": "string",
"t_custom_26": "string",
"t_custom_27": "string",
"t_custom_28": "string",
"t_custom_29": "string",
"t_custom_30": "string",
"t_custom_31": "string",
"t_custom_32": "string",
"t_custom_33": "string",
"t_custom_34": "string",
"t_custom_35": "string",
"t_custom_36": "string",
"t_custom_37": "string",
"t_custom_38": "string",
"t_custom_39": "string",
"t_custom_40": "string",
"t_custom_41": "string",
"t_custom_42": "string",
"t_custom_43": "string",
"t_custom_44": "string",
"t_custom_45": "string",
"t_custom_46": "string",
"t_custom_47": "string",
"t_custom_48": "string",
"t_custom_49": "string",
"t_custom_50": "string",
"t_custom_51": "string",
"t_custom_52": "string",
"t_custom_53": "string",
"t_custom_54": "string",
"t_custom_55": "string",
"t_custom_56": "string",
"t_custom_57": "string",
"t_custom_58": "string",
"t_custom_59": "string",
"t_custom_60": "string",
"t_custom_61": "string",
"t_custom_62": "string",
"t_custom_63": "string",
"t_custom_64": "string",
"t_custom_65": "string",
"t_custom_66": "string",
"t_custom_67": "string",
"t_custom_68": "string",
"t_custom_69": "string",
"t_custom_70": "string",
"t_custom_71": "string",
"t_custom_72": "string",
"t_custom_73": "string",
"t_custom_74": "string",
"t_custom_75": "string",
"t_custom_76": "string",
"t_custom_77": "string",
"t_custom_78": "string",
"t_custom_79": "string",
"t_custom_80": "string",
"t_custom_81": "string",
"t_custom_82": "string",
"t_custom_83": "string",
"t_custom_84": "string",
"t_custom_85": "string",
"t_custom_86": "string",
"t_custom_87": "string",
"t_custom_88": "string",
"t_custom_89": "string",
"t_custom_90": "string",
"t_custom_91": "string",
"t_custom_92": "string",
"t_custom_93": "string",
"t_custom_94": "string",
"t_custom_95": "string",
"t_custom_96": "string",
"t_custom_97": "string",
"t_custom_98": "string",
"t_custom_99": "string",
"t_custom_date_01": "2019-08-24T14:15:22Z",
"t_custom_date_02": "2019-08-24T14:15:22Z",
"t_custom_date_03": "2019-08-24T14:15:22Z",
"t_custom_date_04": "2019-08-24T14:15:22Z",
"t_custom_date_05": "2019-08-24T14:15:22Z",
"t_custom_date_06": "2019-08-24T14:15:22Z",
"t_custom_date_07": "2019-08-24T14:15:22Z",
"t_custom_date_08": "2019-08-24T14:15:22Z",
"t_custom_date_09": "2019-08-24T14:15:22Z",
"t_custom_date_10": "2019-08-24T14:15:22Z",
"t_custom_date_11": "2019-08-24T14:15:22Z",
"t_custom_date_12": "2019-08-24T14:15:22Z",
"t_custom_date_13": "2019-08-24T14:15:22Z",
"t_custom_date_14": "2019-08-24T14:15:22Z",
"t_custom_date_15": "2019-08-24T14:15:22Z",
"t_custom_date_16": "2019-08-24T14:15:22Z",
"t_custom_date_17": "2019-08-24T14:15:22Z",
"t_custom_date_18": "2019-08-24T14:15:22Z",
"t_custom_date_19": "2019-08-24T14:15:22Z",
"t_custom_date_20": "2019-08-24T14:15:22Z",
"t_custom_date_21": "2019-08-24T14:15:22Z",
"t_custom_date_22": "2019-08-24T14:15:22Z",
"t_custom_date_23": "2019-08-24T14:15:22Z",
"t_custom_date_24": "2019-08-24T14:15:22Z",
"t_custom_date_25": "2019-08-24T14:15:22Z",
"t_custom_date_26": "2019-08-24T14:15:22Z",
"t_custom_date_27": "2019-08-24T14:15:22Z",
"t_custom_date_28": "2019-08-24T14:15:22Z",
"t_custom_date_29": "2019-08-24T14:15:22Z",
"t_custom_date_30": "2019-08-24T14:15:22Z",
"t_custom_date_31": "2019-08-24T14:15:22Z",
"t_custom_date_32": "2019-08-24T14:15:22Z",
"t_custom_date_33": "2019-08-24T14:15:22Z",
"t_custom_date_34": "2019-08-24T14:15:22Z",
"t_custom_date_35": "2019-08-24T14:15:22Z",
"t_custom_date_36": "2019-08-24T14:15:22Z",
"t_custom_date_37": "2019-08-24T14:15:22Z",
"t_custom_date_38": "2019-08-24T14:15:22Z",
"t_custom_date_39": "2019-08-24T14:15:22Z",
"t_custom_date_40": "2019-08-24T14:15:22Z",
"t_custom_date_41": "2019-08-24T14:15:22Z",
"t_custom_date_42": "2019-08-24T14:15:22Z",
"t_custom_date_43": "2019-08-24T14:15:22Z",
"t_custom_date_44": "2019-08-24T14:15:22Z",
"t_custom_date_45": "2019-08-24T14:15:22Z",
"t_custom_date_46": "2019-08-24T14:15:22Z",
"t_custom_date_47": "2019-08-24T14:15:22Z",
"t_custom_date_48": "2019-08-24T14:15:22Z",
"t_custom_date_49": "2019-08-24T14:15:22Z",
"t_external_ticketing_add": true,
"t_external_ticketing_link": "string",
"t_forgot_article_count": 0,
"t_forgot_time_unit": 0,
"t_is_child_link": true,
"t_is_forgot_ticket": true,
"t_is_normal_link": true,
"t_is_parent_link": true,
"t_is_view_by_owner": true,
"t_knowledge_base_answer_link": "string",
"t_knowledge_base_answer_uid": "string",
"t_knowledge_base_category_link": "string",
"t_knowledge_base_category_uid": "string",
"t_knowledge_base_id_answer": "string",
"t_knowledge_base_id_category": "string",
"t_last_link_child_update": "string",
"t_last_link_normal_update": "string",
"t_last_link_with": "string",
"t_last_merge_with": "string",
"t_last_owner_view_at": "2019-08-24T14:15:22Z",
"t_queue_type": "string",
"t_reminder_cp_last_time": "2019-08-24T14:15:22Z",
"t_reminder_cp_num": 0,
"t_reminder_tk_last_time": "2019-08-24T14:15:22Z",
"t_reminder_tk_num": 0,
"t_reminder_tk_src": "string",
"t_self_generated_ticket_call_final_state": "string",
"t_self_generated_ticket_type": "string",
"t_social_message_uid": "string",
"t_state_last_update": "2019-08-24T14:15:22Z",
"ticket_time_accounting": [
"string"
],
"ticket_time_accounting_ids": [
0
],
"time_unit": 0,
"title": "string",
"type": "string",
"update_diff_in_min": 0,
"update_escalation_at": "2019-08-24T14:15:22Z",
"update_in_min": 0,
"updated_at": "2019-08-24T14:15:22Z",
"updated_by": "string",
"updated_by_id": 0
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| 406 | Not Acceptable | Error: Invalid argument. | InvalidArgumentException |
| 412 | Precondition Failed | Error: Object required. A required field is missing or empty | GenericObjectRequiredException |
| default | Default | Search tickets | [TicketWithCustomer] |
Upload ticket attachments
Code samples
POST %3CTVOX_HOST%3E/tvox/rest/support/ticket/upload-attachments?submitterId=string HTTP/1.1
Content-Type: application/json
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
Content-Length: 58
{"body":"string","name":"string","size":0,"type":"string"}
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/upload-attachments?submitterId=string",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "{\"body\":\"string\",\"name\":\"string\",\"size\":0,\"type\":\"string\"}",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Content-Type: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request POST \
--url 'https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/upload-attachments?submitterId=string' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID' \
--data '{"body":"string","name":"string","size":0,"type":"string"}'
HttpResponse<String> response = Unirest.post("https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/upload-attachments?submitterId=string")
.header("Content-Type", "application/json")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.body("{\"body\":\"string\",\"name\":\"string\",\"size\":0,\"type\":\"string\"}")
.asString();
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/upload-attachments?submitterId=string"
payload := strings.NewReader("{\"body\":\"string\",\"name\":\"string\",\"size\":0,\"type\":\"string\"}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = JSON.stringify({
"body": "string",
"name": "string",
"size": 0,
"type": "string"
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("POST", "https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/upload-attachments?submitterId=string");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "POST",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/support/ticket/upload-attachments?submitterId=string",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({body: 'string', name: 'string', size: 0, type: 'string'}));
req.end();
import http.client
conn = http.client.HTTPSConnection("")
payload = "{\"body\":\"string\",\"name\":\"string\",\"size\":0,\"type\":\"string\"}"
headers = {
'Content-Type': "application/json",
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("POST", "%3CTVOX_HOST%3E/tvox/rest/support/ticket/upload-attachments?submitterId=string", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/upload-attachments?submitterId=string")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
request.body = "{\"body\":\"string\",\"name\":\"string\",\"size\":0,\"type\":\"string\"}"
response = http.request(request)
puts response.read_body
POST /rest/support/ticket/upload-attachments
Upload attachments
Parameters
Body parameter
{
"body": "string",
"name": "string",
"size": 0,
"type": "string"
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| submitterId | query | string | true | Sender |
| body | body | GenericFile | true | File to upload |
Responses
Example responses
default Response
"string"
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| 404 | Not Found | Error: Object was not found. | GenericObjectWasNotFoundException |
| 412 | Precondition Failed | Error: Object required. A required field is missing or empty | GenericObjectRequiredException |
| 503 | Service Unavailable | Error: Cannot upload file to server | GenericUploadFileErrorException |
| default | Default | Upload attachments | string |
Create ticket
Code samples
POST %3CTVOX_HOST%3E/tvox/rest/support/ticket/IVR?submitterId=string HTTP/1.1
Content-Type: application/json
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
Content-Length: 8490
{"article":{"attachments":[{"data":"string","filename":"string","id":0,"mime-type":"string","preferences":{"property1":"string","property2":"string"},"size":"string"}],"body":"string","cc":"string","content_type":"string","created_at":"2019-08-24T14:15:22Z","created_by":"string","created_by_id":0,"from":"string","id":0,"in_reply_to":"string","internal":true,"message_id":"string","message_id_md5":"string","origin_by":"string","origin_by_id":0,"preferences":{"property1":{},"property2":{}},"references":"string","reply_to":"string","sender":"Agent","sender_id":0,"subject":"string","ticket_id":0,"time_unit":0,"to":"string","type":"email","type_id":0,"updated_at":"2019-08-24T14:15:22Z","updated_by":"string","updated_by_id":0},"article_count":0,"article_ids":[0],"articles":[{"attachments":[{"data":"string","filename":"string","id":0,"mime-type":"string","preferences":{"property1":"string","property2":"string"},"size":"string"}],"body":"string","cc":"string","content_type":"string","created_at":"2019-08-24T14:15:22Z","created_by":"string","created_by_id":0,"from":"string","id":0,"in_reply_to":"string","internal":true,"message_id":"string","message_id_md5":"string","origin_by":"string","origin_by_id":0,"preferences":{"property1":{},"property2":{}},"references":"string","reply_to":"string","sender":"Agent","sender_id":0,"subject":"string","ticket_id":0,"time_unit":0,"to":"string","type":"email","type_id":0,"updated_at":"2019-08-24T14:15:22Z","updated_by":"string","updated_by_id":0}],"attachments":[{"mimeType":"string","name":"string","uuid":"string"}],"close_at":"2019-08-24T14:15:22Z","close_diff_in_min":0,"close_escalation_at":"2019-08-24T14:15:22Z","close_in_min":0,"create_article_sender":"string","create_article_sender_id":0,"create_article_type":"string","create_article_type_id":0,"created_at":"2019-08-24T14:15:22Z","created_by":"string","created_by_id":0,"customer":"string","customerContact":{"type":"USER","uid":"string","username":"string","value":"string"},"customer_id":"string","escalation_at":"2019-08-24T14:15:22Z","first_response_at":"2019-08-24T14:15:22Z","first_response_diff_in_min":0,"first_response_escalation_at":"2019-08-24T14:15:22Z","first_response_in_min":0,"group":"string","group_id":0,"id":0,"last_contact_agent_at":"2019-08-24T14:15:22Z","last_contact_at":"2019-08-24T14:15:22Z","last_contact_customer_at":"2019-08-24T14:15:22Z","last_owner_update_at":"2019-08-24T14:15:22Z","note":"string","number":"string","organization":"string","organization_id":0,"owner":"string","ownerContact":{"type":"USER","uid":"string","username":"string","value":"string"},"owner_id":0,"pending_time":"2019-08-24T14:15:22Z","priority":"1 low","priority_id":0,"state":"new","state_id":0,"t_agent_close_date":"2019-08-24T14:15:22Z","t_agent_get_date":"2019-08-24T14:15:22Z","t_call_link":"string","t_create_call_uid":"string","t_custom_01":"string","t_custom_02":"string","t_custom_03":"string","t_custom_04":"string","t_custom_05":"string","t_custom_06":"string","t_custom_07":"string","t_custom_08":"string","t_custom_09":"string","t_custom_10":"string","t_custom_11":"string","t_custom_12":"string","t_custom_13":"string","t_custom_14":"string","t_custom_15":"string","t_custom_16":"string","t_custom_17":"string","t_custom_18":"string","t_custom_19":"string","t_custom_20":"string","t_custom_21":"string","t_custom_22":"string","t_custom_23":"string","t_custom_24":"string","t_custom_25":"string","t_custom_26":"string","t_custom_27":"string","t_custom_28":"string","t_custom_29":"string","t_custom_30":"string","t_custom_31":"string","t_custom_32":"string","t_custom_33":"string","t_custom_34":"string","t_custom_35":"string","t_custom_36":"string","t_custom_37":"string","t_custom_38":"string","t_custom_39":"string","t_custom_40":"string","t_custom_41":"string","t_custom_42":"string","t_custom_43":"string","t_custom_44":"string","t_custom_45":"string","t_custom_46":"string","t_custom_47":"string","t_custom_48":"string","t_custom_49":"string","t_custom_50":"string","t_custom_51":"string","t_custom_52":"string","t_custom_53":"string","t_custom_54":"string","t_custom_55":"string","t_custom_56":"string","t_custom_57":"string","t_custom_58":"string","t_custom_59":"string","t_custom_60":"string","t_custom_61":"string","t_custom_62":"string","t_custom_63":"string","t_custom_64":"string","t_custom_65":"string","t_custom_66":"string","t_custom_67":"string","t_custom_68":"string","t_custom_69":"string","t_custom_70":"string","t_custom_71":"string","t_custom_72":"string","t_custom_73":"string","t_custom_74":"string","t_custom_75":"string","t_custom_76":"string","t_custom_77":"string","t_custom_78":"string","t_custom_79":"string","t_custom_80":"string","t_custom_81":"string","t_custom_82":"string","t_custom_83":"string","t_custom_84":"string","t_custom_85":"string","t_custom_86":"string","t_custom_87":"string","t_custom_88":"string","t_custom_89":"string","t_custom_90":"string","t_custom_91":"string","t_custom_92":"string","t_custom_93":"string","t_custom_94":"string","t_custom_95":"string","t_custom_96":"string","t_custom_97":"string","t_custom_98":"string","t_custom_99":"string","t_custom_date_01":"2019-08-24T14:15:22Z","t_custom_date_02":"2019-08-24T14:15:22Z","t_custom_date_03":"2019-08-24T14:15:22Z","t_custom_date_04":"2019-08-24T14:15:22Z","t_custom_date_05":"2019-08-24T14:15:22Z","t_custom_date_06":"2019-08-24T14:15:22Z","t_custom_date_07":"2019-08-24T14:15:22Z","t_custom_date_08":"2019-08-24T14:15:22Z","t_custom_date_09":"2019-08-24T14:15:22Z","t_custom_date_10":"2019-08-24T14:15:22Z","t_custom_date_11":"2019-08-24T14:15:22Z","t_custom_date_12":"2019-08-24T14:15:22Z","t_custom_date_13":"2019-08-24T14:15:22Z","t_custom_date_14":"2019-08-24T14:15:22Z","t_custom_date_15":"2019-08-24T14:15:22Z","t_custom_date_16":"2019-08-24T14:15:22Z","t_custom_date_17":"2019-08-24T14:15:22Z","t_custom_date_18":"2019-08-24T14:15:22Z","t_custom_date_19":"2019-08-24T14:15:22Z","t_custom_date_20":"2019-08-24T14:15:22Z","t_custom_date_21":"2019-08-24T14:15:22Z","t_custom_date_22":"2019-08-24T14:15:22Z","t_custom_date_23":"2019-08-24T14:15:22Z","t_custom_date_24":"2019-08-24T14:15:22Z","t_custom_date_25":"2019-08-24T14:15:22Z","t_custom_date_26":"2019-08-24T14:15:22Z","t_custom_date_27":"2019-08-24T14:15:22Z","t_custom_date_28":"2019-08-24T14:15:22Z","t_custom_date_29":"2019-08-24T14:15:22Z","t_custom_date_30":"2019-08-24T14:15:22Z","t_custom_date_31":"2019-08-24T14:15:22Z","t_custom_date_32":"2019-08-24T14:15:22Z","t_custom_date_33":"2019-08-24T14:15:22Z","t_custom_date_34":"2019-08-24T14:15:22Z","t_custom_date_35":"2019-08-24T14:15:22Z","t_custom_date_36":"2019-08-24T14:15:22Z","t_custom_date_37":"2019-08-24T14:15:22Z","t_custom_date_38":"2019-08-24T14:15:22Z","t_custom_date_39":"2019-08-24T14:15:22Z","t_custom_date_40":"2019-08-24T14:15:22Z","t_custom_date_41":"2019-08-24T14:15:22Z","t_custom_date_42":"2019-08-24T14:15:22Z","t_custom_date_43":"2019-08-24T14:15:22Z","t_custom_date_44":"2019-08-24T14:15:22Z","t_custom_date_45":"2019-08-24T14:15:22Z","t_custom_date_46":"2019-08-24T14:15:22Z","t_custom_date_47":"2019-08-24T14:15:22Z","t_custom_date_48":"2019-08-24T14:15:22Z","t_custom_date_49":"2019-08-24T14:15:22Z","t_external_ticketing_add":true,"t_external_ticketing_link":"string","t_forgot_article_count":0,"t_forgot_time_unit":0,"t_is_child_link":true,"t_is_forgot_ticket":true,"t_is_normal_link":true,"t_is_parent_link":true,"t_is_view_by_owner":true,"t_knowledge_base_answer_link":"string","t_knowledge_base_answer_uid":"string","t_knowledge_base_category_link":"string","t_knowledge_base_category_uid":"string","t_knowledge_base_id_answer":"string","t_knowledge_base_id_category":"string","t_last_link_child_update":"string","t_last_link_normal_update":"string","t_last_link_with":"string","t_last_merge_with":"string","t_last_owner_view_at":"2019-08-24T14:15:22Z","t_queue_type":"string","t_reminder_cp_last_time":"2019-08-24T14:15:22Z","t_reminder_cp_num":0,"t_reminder_tk_last_time":"2019-08-24T14:15:22Z","t_reminder_tk_num":0,"t_reminder_tk_src":"string","t_self_generated_ticket_call_final_state":"string","t_self_generated_ticket_type":"string","t_social_message_uid":"string","t_state_last_update":"2019-08-24T14:15:22Z","ticket_time_accounting":["string"],"ticket_time_accounting_ids":[0],"time_unit":0,"title":"string","type":"string","update_diff_in_min":0,"update_escalation_at":"2019-08-24T14:15:22Z","update_in_min":0,"updated_at":"2019-08-24T14:15:22Z","updated_by":"string","updated_by_id":0}
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/IVR?submitterId=string",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "{\"article\":{\"attachments\":[{\"data\":\"string\",\"filename\":\"string\",\"id\":0,\"mime-type\":\"string\",\"preferences\":{\"property1\":\"string\",\"property2\":\"string\"},\"size\":\"string\"}],\"body\":\"string\",\"cc\":\"string\",\"content_type\":\"string\",\"created_at\":\"2019-08-24T14:15:22Z\",\"created_by\":\"string\",\"created_by_id\":0,\"from\":\"string\",\"id\":0,\"in_reply_to\":\"string\",\"internal\":true,\"message_id\":\"string\",\"message_id_md5\":\"string\",\"origin_by\":\"string\",\"origin_by_id\":0,\"preferences\":{\"property1\":{},\"property2\":{}},\"references\":\"string\",\"reply_to\":\"string\",\"sender\":\"Agent\",\"sender_id\":0,\"subject\":\"string\",\"ticket_id\":0,\"time_unit\":0,\"to\":\"string\",\"type\":\"email\",\"type_id\":0,\"updated_at\":\"2019-08-24T14:15:22Z\",\"updated_by\":\"string\",\"updated_by_id\":0},\"article_count\":0,\"article_ids\":[0],\"articles\":[{\"attachments\":[{\"data\":\"string\",\"filename\":\"string\",\"id\":0,\"mime-type\":\"string\",\"preferences\":{\"property1\":\"string\",\"property2\":\"string\"},\"size\":\"string\"}],\"body\":\"string\",\"cc\":\"string\",\"content_type\":\"string\",\"created_at\":\"2019-08-24T14:15:22Z\",\"created_by\":\"string\",\"created_by_id\":0,\"from\":\"string\",\"id\":0,\"in_reply_to\":\"string\",\"internal\":true,\"message_id\":\"string\",\"message_id_md5\":\"string\",\"origin_by\":\"string\",\"origin_by_id\":0,\"preferences\":{\"property1\":{},\"property2\":{}},\"references\":\"string\",\"reply_to\":\"string\",\"sender\":\"Agent\",\"sender_id\":0,\"subject\":\"string\",\"ticket_id\":0,\"time_unit\":0,\"to\":\"string\",\"type\":\"email\",\"type_id\":0,\"updated_at\":\"2019-08-24T14:15:22Z\",\"updated_by\":\"string\",\"updated_by_id\":0}],\"attachments\":[{\"mimeType\":\"string\",\"name\":\"string\",\"uuid\":\"string\"}],\"close_at\":\"2019-08-24T14:15:22Z\",\"close_diff_in_min\":0,\"close_escalation_at\":\"2019-08-24T14:15:22Z\",\"close_in_min\":0,\"create_article_sender\":\"string\",\"create_article_sender_id\":0,\"create_article_type\":\"string\",\"create_article_type_id\":0,\"created_at\":\"2019-08-24T14:15:22Z\",\"created_by\":\"string\",\"created_by_id\":0,\"customer\":\"string\",\"customerContact\":{\"type\":\"USER\",\"uid\":\"string\",\"username\":\"string\",\"value\":\"string\"},\"customer_id\":\"string\",\"escalation_at\":\"2019-08-24T14:15:22Z\",\"first_response_at\":\"2019-08-24T14:15:22Z\",\"first_response_diff_in_min\":0,\"first_response_escalation_at\":\"2019-08-24T14:15:22Z\",\"first_response_in_min\":0,\"group\":\"string\",\"group_id\":0,\"id\":0,\"last_contact_agent_at\":\"2019-08-24T14:15:22Z\",\"last_contact_at\":\"2019-08-24T14:15:22Z\",\"last_contact_customer_at\":\"2019-08-24T14:15:22Z\",\"last_owner_update_at\":\"2019-08-24T14:15:22Z\",\"note\":\"string\",\"number\":\"string\",\"organization\":\"string\",\"organization_id\":0,\"owner\":\"string\",\"ownerContact\":{\"type\":\"USER\",\"uid\":\"string\",\"username\":\"string\",\"value\":\"string\"},\"owner_id\":0,\"pending_time\":\"2019-08-24T14:15:22Z\",\"priority\":\"1 low\",\"priority_id\":0,\"state\":\"new\",\"state_id\":0,\"t_agent_close_date\":\"2019-08-24T14:15:22Z\",\"t_agent_get_date\":\"2019-08-24T14:15:22Z\",\"t_call_link\":\"string\",\"t_create_call_uid\":\"string\",\"t_custom_01\":\"string\",\"t_custom_02\":\"string\",\"t_custom_03\":\"string\",\"t_custom_04\":\"string\",\"t_custom_05\":\"string\",\"t_custom_06\":\"string\",\"t_custom_07\":\"string\",\"t_custom_08\":\"string\",\"t_custom_09\":\"string\",\"t_custom_10\":\"string\",\"t_custom_11\":\"string\",\"t_custom_12\":\"string\",\"t_custom_13\":\"string\",\"t_custom_14\":\"string\",\"t_custom_15\":\"string\",\"t_custom_16\":\"string\",\"t_custom_17\":\"string\",\"t_custom_18\":\"string\",\"t_custom_19\":\"string\",\"t_custom_20\":\"string\",\"t_custom_21\":\"string\",\"t_custom_22\":\"string\",\"t_custom_23\":\"string\",\"t_custom_24\":\"string\",\"t_custom_25\":\"string\",\"t_custom_26\":\"string\",\"t_custom_27\":\"string\",\"t_custom_28\":\"string\",\"t_custom_29\":\"string\",\"t_custom_30\":\"string\",\"t_custom_31\":\"string\",\"t_custom_32\":\"string\",\"t_custom_33\":\"string\",\"t_custom_34\":\"string\",\"t_custom_35\":\"string\",\"t_custom_36\":\"string\",\"t_custom_37\":\"string\",\"t_custom_38\":\"string\",\"t_custom_39\":\"string\",\"t_custom_40\":\"string\",\"t_custom_41\":\"string\",\"t_custom_42\":\"string\",\"t_custom_43\":\"string\",\"t_custom_44\":\"string\",\"t_custom_45\":\"string\",\"t_custom_46\":\"string\",\"t_custom_47\":\"string\",\"t_custom_48\":\"string\",\"t_custom_49\":\"string\",\"t_custom_50\":\"string\",\"t_custom_51\":\"string\",\"t_custom_52\":\"string\",\"t_custom_53\":\"string\",\"t_custom_54\":\"string\",\"t_custom_55\":\"string\",\"t_custom_56\":\"string\",\"t_custom_57\":\"string\",\"t_custom_58\":\"string\",\"t_custom_59\":\"string\",\"t_custom_60\":\"string\",\"t_custom_61\":\"string\",\"t_custom_62\":\"string\",\"t_custom_63\":\"string\",\"t_custom_64\":\"string\",\"t_custom_65\":\"string\",\"t_custom_66\":\"string\",\"t_custom_67\":\"string\",\"t_custom_68\":\"string\",\"t_custom_69\":\"string\",\"t_custom_70\":\"string\",\"t_custom_71\":\"string\",\"t_custom_72\":\"string\",\"t_custom_73\":\"string\",\"t_custom_74\":\"string\",\"t_custom_75\":\"string\",\"t_custom_76\":\"string\",\"t_custom_77\":\"string\",\"t_custom_78\":\"string\",\"t_custom_79\":\"string\",\"t_custom_80\":\"string\",\"t_custom_81\":\"string\",\"t_custom_82\":\"string\",\"t_custom_83\":\"string\",\"t_custom_84\":\"string\",\"t_custom_85\":\"string\",\"t_custom_86\":\"string\",\"t_custom_87\":\"string\",\"t_custom_88\":\"string\",\"t_custom_89\":\"string\",\"t_custom_90\":\"string\",\"t_custom_91\":\"string\",\"t_custom_92\":\"string\",\"t_custom_93\":\"string\",\"t_custom_94\":\"string\",\"t_custom_95\":\"string\",\"t_custom_96\":\"string\",\"t_custom_97\":\"string\",\"t_custom_98\":\"string\",\"t_custom_99\":\"string\",\"t_custom_date_01\":\"2019-08-24T14:15:22Z\",\"t_custom_date_02\":\"2019-08-24T14:15:22Z\",\"t_custom_date_03\":\"2019-08-24T14:15:22Z\",\"t_custom_date_04\":\"2019-08-24T14:15:22Z\",\"t_custom_date_05\":\"2019-08-24T14:15:22Z\",\"t_custom_date_06\":\"2019-08-24T14:15:22Z\",\"t_custom_date_07\":\"2019-08-24T14:15:22Z\",\"t_custom_date_08\":\"2019-08-24T14:15:22Z\",\"t_custom_date_09\":\"2019-08-24T14:15:22Z\",\"t_custom_date_10\":\"2019-08-24T14:15:22Z\",\"t_custom_date_11\":\"2019-08-24T14:15:22Z\",\"t_custom_date_12\":\"2019-08-24T14:15:22Z\",\"t_custom_date_13\":\"2019-08-24T14:15:22Z\",\"t_custom_date_14\":\"2019-08-24T14:15:22Z\",\"t_custom_date_15\":\"2019-08-24T14:15:22Z\",\"t_custom_date_16\":\"2019-08-24T14:15:22Z\",\"t_custom_date_17\":\"2019-08-24T14:15:22Z\",\"t_custom_date_18\":\"2019-08-24T14:15:22Z\",\"t_custom_date_19\":\"2019-08-24T14:15:22Z\",\"t_custom_date_20\":\"2019-08-24T14:15:22Z\",\"t_custom_date_21\":\"2019-08-24T14:15:22Z\",\"t_custom_date_22\":\"2019-08-24T14:15:22Z\",\"t_custom_date_23\":\"2019-08-24T14:15:22Z\",\"t_custom_date_24\":\"2019-08-24T14:15:22Z\",\"t_custom_date_25\":\"2019-08-24T14:15:22Z\",\"t_custom_date_26\":\"2019-08-24T14:15:22Z\",\"t_custom_date_27\":\"2019-08-24T14:15:22Z\",\"t_custom_date_28\":\"2019-08-24T14:15:22Z\",\"t_custom_date_29\":\"2019-08-24T14:15:22Z\",\"t_custom_date_30\":\"2019-08-24T14:15:22Z\",\"t_custom_date_31\":\"2019-08-24T14:15:22Z\",\"t_custom_date_32\":\"2019-08-24T14:15:22Z\",\"t_custom_date_33\":\"2019-08-24T14:15:22Z\",\"t_custom_date_34\":\"2019-08-24T14:15:22Z\",\"t_custom_date_35\":\"2019-08-24T14:15:22Z\",\"t_custom_date_36\":\"2019-08-24T14:15:22Z\",\"t_custom_date_37\":\"2019-08-24T14:15:22Z\",\"t_custom_date_38\":\"2019-08-24T14:15:22Z\",\"t_custom_date_39\":\"2019-08-24T14:15:22Z\",\"t_custom_date_40\":\"2019-08-24T14:15:22Z\",\"t_custom_date_41\":\"2019-08-24T14:15:22Z\",\"t_custom_date_42\":\"2019-08-24T14:15:22Z\",\"t_custom_date_43\":\"2019-08-24T14:15:22Z\",\"t_custom_date_44\":\"2019-08-24T14:15:22Z\",\"t_custom_date_45\":\"2019-08-24T14:15:22Z\",\"t_custom_date_46\":\"2019-08-24T14:15:22Z\",\"t_custom_date_47\":\"2019-08-24T14:15:22Z\",\"t_custom_date_48\":\"2019-08-24T14:15:22Z\",\"t_custom_date_49\":\"2019-08-24T14:15:22Z\",\"t_external_ticketing_add\":true,\"t_external_ticketing_link\":\"string\",\"t_forgot_article_count\":0,\"t_forgot_time_unit\":0,\"t_is_child_link\":true,\"t_is_forgot_ticket\":true,\"t_is_normal_link\":true,\"t_is_parent_link\":true,\"t_is_view_by_owner\":true,\"t_knowledge_base_answer_link\":\"string\",\"t_knowledge_base_answer_uid\":\"string\",\"t_knowledge_base_category_link\":\"string\",\"t_knowledge_base_category_uid\":\"string\",\"t_knowledge_base_id_answer\":\"string\",\"t_knowledge_base_id_category\":\"string\",\"t_last_link_child_update\":\"string\",\"t_last_link_normal_update\":\"string\",\"t_last_link_with\":\"string\",\"t_last_merge_with\":\"string\",\"t_last_owner_view_at\":\"2019-08-24T14:15:22Z\",\"t_queue_type\":\"string\",\"t_reminder_cp_last_time\":\"2019-08-24T14:15:22Z\",\"t_reminder_cp_num\":0,\"t_reminder_tk_last_time\":\"2019-08-24T14:15:22Z\",\"t_reminder_tk_num\":0,\"t_reminder_tk_src\":\"string\",\"t_self_generated_ticket_call_final_state\":\"string\",\"t_self_generated_ticket_type\":\"string\",\"t_social_message_uid\":\"string\",\"t_state_last_update\":\"2019-08-24T14:15:22Z\",\"ticket_time_accounting\":[\"string\"],\"ticket_time_accounting_ids\":[0],\"time_unit\":0,\"title\":\"string\",\"type\":\"string\",\"update_diff_in_min\":0,\"update_escalation_at\":\"2019-08-24T14:15:22Z\",\"update_in_min\":0,\"updated_at\":\"2019-08-24T14:15:22Z\",\"updated_by\":\"string\",\"updated_by_id\":0}",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Content-Type: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request POST \
--url 'https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/IVR?submitterId=string' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID' \
--data '{"article":{"attachments":[{"data":"string","filename":"string","id":0,"mime-type":"string","preferences":{"property1":"string","property2":"string"},"size":"string"}],"body":"string","cc":"string","content_type":"string","created_at":"2019-08-24T14:15:22Z","created_by":"string","created_by_id":0,"from":"string","id":0,"in_reply_to":"string","internal":true,"message_id":"string","message_id_md5":"string","origin_by":"string","origin_by_id":0,"preferences":{"property1":{},"property2":{}},"references":"string","reply_to":"string","sender":"Agent","sender_id":0,"subject":"string","ticket_id":0,"time_unit":0,"to":"string","type":"email","type_id":0,"updated_at":"2019-08-24T14:15:22Z","updated_by":"string","updated_by_id":0},"article_count":0,"article_ids":[0],"articles":[{"attachments":[{"data":"string","filename":"string","id":0,"mime-type":"string","preferences":{"property1":"string","property2":"string"},"size":"string"}],"body":"string","cc":"string","content_type":"string","created_at":"2019-08-24T14:15:22Z","created_by":"string","created_by_id":0,"from":"string","id":0,"in_reply_to":"string","internal":true,"message_id":"string","message_id_md5":"string","origin_by":"string","origin_by_id":0,"preferences":{"property1":{},"property2":{}},"references":"string","reply_to":"string","sender":"Agent","sender_id":0,"subject":"string","ticket_id":0,"time_unit":0,"to":"string","type":"email","type_id":0,"updated_at":"2019-08-24T14:15:22Z","updated_by":"string","updated_by_id":0}],"attachments":[{"mimeType":"string","name":"string","uuid":"string"}],"close_at":"2019-08-24T14:15:22Z","close_diff_in_min":0,"close_escalation_at":"2019-08-24T14:15:22Z","close_in_min":0,"create_article_sender":"string","create_article_sender_id":0,"create_article_type":"string","create_article_type_id":0,"created_at":"2019-08-24T14:15:22Z","created_by":"string","created_by_id":0,"customer":"string","customerContact":{"type":"USER","uid":"string","username":"string","value":"string"},"customer_id":"string","escalation_at":"2019-08-24T14:15:22Z","first_response_at":"2019-08-24T14:15:22Z","first_response_diff_in_min":0,"first_response_escalation_at":"2019-08-24T14:15:22Z","first_response_in_min":0,"group":"string","group_id":0,"id":0,"last_contact_agent_at":"2019-08-24T14:15:22Z","last_contact_at":"2019-08-24T14:15:22Z","last_contact_customer_at":"2019-08-24T14:15:22Z","last_owner_update_at":"2019-08-24T14:15:22Z","note":"string","number":"string","organization":"string","organization_id":0,"owner":"string","ownerContact":{"type":"USER","uid":"string","username":"string","value":"string"},"owner_id":0,"pending_time":"2019-08-24T14:15:22Z","priority":"1 low","priority_id":0,"state":"new","state_id":0,"t_agent_close_date":"2019-08-24T14:15:22Z","t_agent_get_date":"2019-08-24T14:15:22Z","t_call_link":"string","t_create_call_uid":"string","t_custom_01":"string","t_custom_02":"string","t_custom_03":"string","t_custom_04":"string","t_custom_05":"string","t_custom_06":"string","t_custom_07":"string","t_custom_08":"string","t_custom_09":"string","t_custom_10":"string","t_custom_11":"string","t_custom_12":"string","t_custom_13":"string","t_custom_14":"string","t_custom_15":"string","t_custom_16":"string","t_custom_17":"string","t_custom_18":"string","t_custom_19":"string","t_custom_20":"string","t_custom_21":"string","t_custom_22":"string","t_custom_23":"string","t_custom_24":"string","t_custom_25":"string","t_custom_26":"string","t_custom_27":"string","t_custom_28":"string","t_custom_29":"string","t_custom_30":"string","t_custom_31":"string","t_custom_32":"string","t_custom_33":"string","t_custom_34":"string","t_custom_35":"string","t_custom_36":"string","t_custom_37":"string","t_custom_38":"string","t_custom_39":"string","t_custom_40":"string","t_custom_41":"string","t_custom_42":"string","t_custom_43":"string","t_custom_44":"string","t_custom_45":"string","t_custom_46":"string","t_custom_47":"string","t_custom_48":"string","t_custom_49":"string","t_custom_50":"string","t_custom_51":"string","t_custom_52":"string","t_custom_53":"string","t_custom_54":"string","t_custom_55":"string","t_custom_56":"string","t_custom_57":"string","t_custom_58":"string","t_custom_59":"string","t_custom_60":"string","t_custom_61":"string","t_custom_62":"string","t_custom_63":"string","t_custom_64":"string","t_custom_65":"string","t_custom_66":"string","t_custom_67":"string","t_custom_68":"string","t_custom_69":"string","t_custom_70":"string","t_custom_71":"string","t_custom_72":"string","t_custom_73":"string","t_custom_74":"string","t_custom_75":"string","t_custom_76":"string","t_custom_77":"string","t_custom_78":"string","t_custom_79":"string","t_custom_80":"string","t_custom_81":"string","t_custom_82":"string","t_custom_83":"string","t_custom_84":"string","t_custom_85":"string","t_custom_86":"string","t_custom_87":"string","t_custom_88":"string","t_custom_89":"string","t_custom_90":"string","t_custom_91":"string","t_custom_92":"string","t_custom_93":"string","t_custom_94":"string","t_custom_95":"string","t_custom_96":"string","t_custom_97":"string","t_custom_98":"string","t_custom_99":"string","t_custom_date_01":"2019-08-24T14:15:22Z","t_custom_date_02":"2019-08-24T14:15:22Z","t_custom_date_03":"2019-08-24T14:15:22Z","t_custom_date_04":"2019-08-24T14:15:22Z","t_custom_date_05":"2019-08-24T14:15:22Z","t_custom_date_06":"2019-08-24T14:15:22Z","t_custom_date_07":"2019-08-24T14:15:22Z","t_custom_date_08":"2019-08-24T14:15:22Z","t_custom_date_09":"2019-08-24T14:15:22Z","t_custom_date_10":"2019-08-24T14:15:22Z","t_custom_date_11":"2019-08-24T14:15:22Z","t_custom_date_12":"2019-08-24T14:15:22Z","t_custom_date_13":"2019-08-24T14:15:22Z","t_custom_date_14":"2019-08-24T14:15:22Z","t_custom_date_15":"2019-08-24T14:15:22Z","t_custom_date_16":"2019-08-24T14:15:22Z","t_custom_date_17":"2019-08-24T14:15:22Z","t_custom_date_18":"2019-08-24T14:15:22Z","t_custom_date_19":"2019-08-24T14:15:22Z","t_custom_date_20":"2019-08-24T14:15:22Z","t_custom_date_21":"2019-08-24T14:15:22Z","t_custom_date_22":"2019-08-24T14:15:22Z","t_custom_date_23":"2019-08-24T14:15:22Z","t_custom_date_24":"2019-08-24T14:15:22Z","t_custom_date_25":"2019-08-24T14:15:22Z","t_custom_date_26":"2019-08-24T14:15:22Z","t_custom_date_27":"2019-08-24T14:15:22Z","t_custom_date_28":"2019-08-24T14:15:22Z","t_custom_date_29":"2019-08-24T14:15:22Z","t_custom_date_30":"2019-08-24T14:15:22Z","t_custom_date_31":"2019-08-24T14:15:22Z","t_custom_date_32":"2019-08-24T14:15:22Z","t_custom_date_33":"2019-08-24T14:15:22Z","t_custom_date_34":"2019-08-24T14:15:22Z","t_custom_date_35":"2019-08-24T14:15:22Z","t_custom_date_36":"2019-08-24T14:15:22Z","t_custom_date_37":"2019-08-24T14:15:22Z","t_custom_date_38":"2019-08-24T14:15:22Z","t_custom_date_39":"2019-08-24T14:15:22Z","t_custom_date_40":"2019-08-24T14:15:22Z","t_custom_date_41":"2019-08-24T14:15:22Z","t_custom_date_42":"2019-08-24T14:15:22Z","t_custom_date_43":"2019-08-24T14:15:22Z","t_custom_date_44":"2019-08-24T14:15:22Z","t_custom_date_45":"2019-08-24T14:15:22Z","t_custom_date_46":"2019-08-24T14:15:22Z","t_custom_date_47":"2019-08-24T14:15:22Z","t_custom_date_48":"2019-08-24T14:15:22Z","t_custom_date_49":"2019-08-24T14:15:22Z","t_external_ticketing_add":true,"t_external_ticketing_link":"string","t_forgot_article_count":0,"t_forgot_time_unit":0,"t_is_child_link":true,"t_is_forgot_ticket":true,"t_is_normal_link":true,"t_is_parent_link":true,"t_is_view_by_owner":true,"t_knowledge_base_answer_link":"string","t_knowledge_base_answer_uid":"string","t_knowledge_base_category_link":"string","t_knowledge_base_category_uid":"string","t_knowledge_base_id_answer":"string","t_knowledge_base_id_category":"string","t_last_link_child_update":"string","t_last_link_normal_update":"string","t_last_link_with":"string","t_last_merge_with":"string","t_last_owner_view_at":"2019-08-24T14:15:22Z","t_queue_type":"string","t_reminder_cp_last_time":"2019-08-24T14:15:22Z","t_reminder_cp_num":0,"t_reminder_tk_last_time":"2019-08-24T14:15:22Z","t_reminder_tk_num":0,"t_reminder_tk_src":"string","t_self_generated_ticket_call_final_state":"string","t_self_generated_ticket_type":"string","t_social_message_uid":"string","t_state_last_update":"2019-08-24T14:15:22Z","ticket_time_accounting":["string"],"ticket_time_accounting_ids":[0],"time_unit":0,"title":"string","type":"string","update_diff_in_min":0,"update_escalation_at":"2019-08-24T14:15:22Z","update_in_min":0,"updated_at":"2019-08-24T14:15:22Z","updated_by":"string","updated_by_id":0}'
HttpResponse<String> response = Unirest.post("https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/IVR?submitterId=string")
.header("Content-Type", "application/json")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.body("{\"article\":{\"attachments\":[{\"data\":\"string\",\"filename\":\"string\",\"id\":0,\"mime-type\":\"string\",\"preferences\":{\"property1\":\"string\",\"property2\":\"string\"},\"size\":\"string\"}],\"body\":\"string\",\"cc\":\"string\",\"content_type\":\"string\",\"created_at\":\"2019-08-24T14:15:22Z\",\"created_by\":\"string\",\"created_by_id\":0,\"from\":\"string\",\"id\":0,\"in_reply_to\":\"string\",\"internal\":true,\"message_id\":\"string\",\"message_id_md5\":\"string\",\"origin_by\":\"string\",\"origin_by_id\":0,\"preferences\":{\"property1\":{},\"property2\":{}},\"references\":\"string\",\"reply_to\":\"string\",\"sender\":\"Agent\",\"sender_id\":0,\"subject\":\"string\",\"ticket_id\":0,\"time_unit\":0,\"to\":\"string\",\"type\":\"email\",\"type_id\":0,\"updated_at\":\"2019-08-24T14:15:22Z\",\"updated_by\":\"string\",\"updated_by_id\":0},\"article_count\":0,\"article_ids\":[0],\"articles\":[{\"attachments\":[{\"data\":\"string\",\"filename\":\"string\",\"id\":0,\"mime-type\":\"string\",\"preferences\":{\"property1\":\"string\",\"property2\":\"string\"},\"size\":\"string\"}],\"body\":\"string\",\"cc\":\"string\",\"content_type\":\"string\",\"created_at\":\"2019-08-24T14:15:22Z\",\"created_by\":\"string\",\"created_by_id\":0,\"from\":\"string\",\"id\":0,\"in_reply_to\":\"string\",\"internal\":true,\"message_id\":\"string\",\"message_id_md5\":\"string\",\"origin_by\":\"string\",\"origin_by_id\":0,\"preferences\":{\"property1\":{},\"property2\":{}},\"references\":\"string\",\"reply_to\":\"string\",\"sender\":\"Agent\",\"sender_id\":0,\"subject\":\"string\",\"ticket_id\":0,\"time_unit\":0,\"to\":\"string\",\"type\":\"email\",\"type_id\":0,\"updated_at\":\"2019-08-24T14:15:22Z\",\"updated_by\":\"string\",\"updated_by_id\":0}],\"attachments\":[{\"mimeType\":\"string\",\"name\":\"string\",\"uuid\":\"string\"}],\"close_at\":\"2019-08-24T14:15:22Z\",\"close_diff_in_min\":0,\"close_escalation_at\":\"2019-08-24T14:15:22Z\",\"close_in_min\":0,\"create_article_sender\":\"string\",\"create_article_sender_id\":0,\"create_article_type\":\"string\",\"create_article_type_id\":0,\"created_at\":\"2019-08-24T14:15:22Z\",\"created_by\":\"string\",\"created_by_id\":0,\"customer\":\"string\",\"customerContact\":{\"type\":\"USER\",\"uid\":\"string\",\"username\":\"string\",\"value\":\"string\"},\"customer_id\":\"string\",\"escalation_at\":\"2019-08-24T14:15:22Z\",\"first_response_at\":\"2019-08-24T14:15:22Z\",\"first_response_diff_in_min\":0,\"first_response_escalation_at\":\"2019-08-24T14:15:22Z\",\"first_response_in_min\":0,\"group\":\"string\",\"group_id\":0,\"id\":0,\"last_contact_agent_at\":\"2019-08-24T14:15:22Z\",\"last_contact_at\":\"2019-08-24T14:15:22Z\",\"last_contact_customer_at\":\"2019-08-24T14:15:22Z\",\"last_owner_update_at\":\"2019-08-24T14:15:22Z\",\"note\":\"string\",\"number\":\"string\",\"organization\":\"string\",\"organization_id\":0,\"owner\":\"string\",\"ownerContact\":{\"type\":\"USER\",\"uid\":\"string\",\"username\":\"string\",\"value\":\"string\"},\"owner_id\":0,\"pending_time\":\"2019-08-24T14:15:22Z\",\"priority\":\"1 low\",\"priority_id\":0,\"state\":\"new\",\"state_id\":0,\"t_agent_close_date\":\"2019-08-24T14:15:22Z\",\"t_agent_get_date\":\"2019-08-24T14:15:22Z\",\"t_call_link\":\"string\",\"t_create_call_uid\":\"string\",\"t_custom_01\":\"string\",\"t_custom_02\":\"string\",\"t_custom_03\":\"string\",\"t_custom_04\":\"string\",\"t_custom_05\":\"string\",\"t_custom_06\":\"string\",\"t_custom_07\":\"string\",\"t_custom_08\":\"string\",\"t_custom_09\":\"string\",\"t_custom_10\":\"string\",\"t_custom_11\":\"string\",\"t_custom_12\":\"string\",\"t_custom_13\":\"string\",\"t_custom_14\":\"string\",\"t_custom_15\":\"string\",\"t_custom_16\":\"string\",\"t_custom_17\":\"string\",\"t_custom_18\":\"string\",\"t_custom_19\":\"string\",\"t_custom_20\":\"string\",\"t_custom_21\":\"string\",\"t_custom_22\":\"string\",\"t_custom_23\":\"string\",\"t_custom_24\":\"string\",\"t_custom_25\":\"string\",\"t_custom_26\":\"string\",\"t_custom_27\":\"string\",\"t_custom_28\":\"string\",\"t_custom_29\":\"string\",\"t_custom_30\":\"string\",\"t_custom_31\":\"string\",\"t_custom_32\":\"string\",\"t_custom_33\":\"string\",\"t_custom_34\":\"string\",\"t_custom_35\":\"string\",\"t_custom_36\":\"string\",\"t_custom_37\":\"string\",\"t_custom_38\":\"string\",\"t_custom_39\":\"string\",\"t_custom_40\":\"string\",\"t_custom_41\":\"string\",\"t_custom_42\":\"string\",\"t_custom_43\":\"string\",\"t_custom_44\":\"string\",\"t_custom_45\":\"string\",\"t_custom_46\":\"string\",\"t_custom_47\":\"string\",\"t_custom_48\":\"string\",\"t_custom_49\":\"string\",\"t_custom_50\":\"string\",\"t_custom_51\":\"string\",\"t_custom_52\":\"string\",\"t_custom_53\":\"string\",\"t_custom_54\":\"string\",\"t_custom_55\":\"string\",\"t_custom_56\":\"string\",\"t_custom_57\":\"string\",\"t_custom_58\":\"string\",\"t_custom_59\":\"string\",\"t_custom_60\":\"string\",\"t_custom_61\":\"string\",\"t_custom_62\":\"string\",\"t_custom_63\":\"string\",\"t_custom_64\":\"string\",\"t_custom_65\":\"string\",\"t_custom_66\":\"string\",\"t_custom_67\":\"string\",\"t_custom_68\":\"string\",\"t_custom_69\":\"string\",\"t_custom_70\":\"string\",\"t_custom_71\":\"string\",\"t_custom_72\":\"string\",\"t_custom_73\":\"string\",\"t_custom_74\":\"string\",\"t_custom_75\":\"string\",\"t_custom_76\":\"string\",\"t_custom_77\":\"string\",\"t_custom_78\":\"string\",\"t_custom_79\":\"string\",\"t_custom_80\":\"string\",\"t_custom_81\":\"string\",\"t_custom_82\":\"string\",\"t_custom_83\":\"string\",\"t_custom_84\":\"string\",\"t_custom_85\":\"string\",\"t_custom_86\":\"string\",\"t_custom_87\":\"string\",\"t_custom_88\":\"string\",\"t_custom_89\":\"string\",\"t_custom_90\":\"string\",\"t_custom_91\":\"string\",\"t_custom_92\":\"string\",\"t_custom_93\":\"string\",\"t_custom_94\":\"string\",\"t_custom_95\":\"string\",\"t_custom_96\":\"string\",\"t_custom_97\":\"string\",\"t_custom_98\":\"string\",\"t_custom_99\":\"string\",\"t_custom_date_01\":\"2019-08-24T14:15:22Z\",\"t_custom_date_02\":\"2019-08-24T14:15:22Z\",\"t_custom_date_03\":\"2019-08-24T14:15:22Z\",\"t_custom_date_04\":\"2019-08-24T14:15:22Z\",\"t_custom_date_05\":\"2019-08-24T14:15:22Z\",\"t_custom_date_06\":\"2019-08-24T14:15:22Z\",\"t_custom_date_07\":\"2019-08-24T14:15:22Z\",\"t_custom_date_08\":\"2019-08-24T14:15:22Z\",\"t_custom_date_09\":\"2019-08-24T14:15:22Z\",\"t_custom_date_10\":\"2019-08-24T14:15:22Z\",\"t_custom_date_11\":\"2019-08-24T14:15:22Z\",\"t_custom_date_12\":\"2019-08-24T14:15:22Z\",\"t_custom_date_13\":\"2019-08-24T14:15:22Z\",\"t_custom_date_14\":\"2019-08-24T14:15:22Z\",\"t_custom_date_15\":\"2019-08-24T14:15:22Z\",\"t_custom_date_16\":\"2019-08-24T14:15:22Z\",\"t_custom_date_17\":\"2019-08-24T14:15:22Z\",\"t_custom_date_18\":\"2019-08-24T14:15:22Z\",\"t_custom_date_19\":\"2019-08-24T14:15:22Z\",\"t_custom_date_20\":\"2019-08-24T14:15:22Z\",\"t_custom_date_21\":\"2019-08-24T14:15:22Z\",\"t_custom_date_22\":\"2019-08-24T14:15:22Z\",\"t_custom_date_23\":\"2019-08-24T14:15:22Z\",\"t_custom_date_24\":\"2019-08-24T14:15:22Z\",\"t_custom_date_25\":\"2019-08-24T14:15:22Z\",\"t_custom_date_26\":\"2019-08-24T14:15:22Z\",\"t_custom_date_27\":\"2019-08-24T14:15:22Z\",\"t_custom_date_28\":\"2019-08-24T14:15:22Z\",\"t_custom_date_29\":\"2019-08-24T14:15:22Z\",\"t_custom_date_30\":\"2019-08-24T14:15:22Z\",\"t_custom_date_31\":\"2019-08-24T14:15:22Z\",\"t_custom_date_32\":\"2019-08-24T14:15:22Z\",\"t_custom_date_33\":\"2019-08-24T14:15:22Z\",\"t_custom_date_34\":\"2019-08-24T14:15:22Z\",\"t_custom_date_35\":\"2019-08-24T14:15:22Z\",\"t_custom_date_36\":\"2019-08-24T14:15:22Z\",\"t_custom_date_37\":\"2019-08-24T14:15:22Z\",\"t_custom_date_38\":\"2019-08-24T14:15:22Z\",\"t_custom_date_39\":\"2019-08-24T14:15:22Z\",\"t_custom_date_40\":\"2019-08-24T14:15:22Z\",\"t_custom_date_41\":\"2019-08-24T14:15:22Z\",\"t_custom_date_42\":\"2019-08-24T14:15:22Z\",\"t_custom_date_43\":\"2019-08-24T14:15:22Z\",\"t_custom_date_44\":\"2019-08-24T14:15:22Z\",\"t_custom_date_45\":\"2019-08-24T14:15:22Z\",\"t_custom_date_46\":\"2019-08-24T14:15:22Z\",\"t_custom_date_47\":\"2019-08-24T14:15:22Z\",\"t_custom_date_48\":\"2019-08-24T14:15:22Z\",\"t_custom_date_49\":\"2019-08-24T14:15:22Z\",\"t_external_ticketing_add\":true,\"t_external_ticketing_link\":\"string\",\"t_forgot_article_count\":0,\"t_forgot_time_unit\":0,\"t_is_child_link\":true,\"t_is_forgot_ticket\":true,\"t_is_normal_link\":true,\"t_is_parent_link\":true,\"t_is_view_by_owner\":true,\"t_knowledge_base_answer_link\":\"string\",\"t_knowledge_base_answer_uid\":\"string\",\"t_knowledge_base_category_link\":\"string\",\"t_knowledge_base_category_uid\":\"string\",\"t_knowledge_base_id_answer\":\"string\",\"t_knowledge_base_id_category\":\"string\",\"t_last_link_child_update\":\"string\",\"t_last_link_normal_update\":\"string\",\"t_last_link_with\":\"string\",\"t_last_merge_with\":\"string\",\"t_last_owner_view_at\":\"2019-08-24T14:15:22Z\",\"t_queue_type\":\"string\",\"t_reminder_cp_last_time\":\"2019-08-24T14:15:22Z\",\"t_reminder_cp_num\":0,\"t_reminder_tk_last_time\":\"2019-08-24T14:15:22Z\",\"t_reminder_tk_num\":0,\"t_reminder_tk_src\":\"string\",\"t_self_generated_ticket_call_final_state\":\"string\",\"t_self_generated_ticket_type\":\"string\",\"t_social_message_uid\":\"string\",\"t_state_last_update\":\"2019-08-24T14:15:22Z\",\"ticket_time_accounting\":[\"string\"],\"ticket_time_accounting_ids\":[0],\"time_unit\":0,\"title\":\"string\",\"type\":\"string\",\"update_diff_in_min\":0,\"update_escalation_at\":\"2019-08-24T14:15:22Z\",\"update_in_min\":0,\"updated_at\":\"2019-08-24T14:15:22Z\",\"updated_by\":\"string\",\"updated_by_id\":0}")
.asString();
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/IVR?submitterId=string"
payload := strings.NewReader("{\"article\":{\"attachments\":[{\"data\":\"string\",\"filename\":\"string\",\"id\":0,\"mime-type\":\"string\",\"preferences\":{\"property1\":\"string\",\"property2\":\"string\"},\"size\":\"string\"}],\"body\":\"string\",\"cc\":\"string\",\"content_type\":\"string\",\"created_at\":\"2019-08-24T14:15:22Z\",\"created_by\":\"string\",\"created_by_id\":0,\"from\":\"string\",\"id\":0,\"in_reply_to\":\"string\",\"internal\":true,\"message_id\":\"string\",\"message_id_md5\":\"string\",\"origin_by\":\"string\",\"origin_by_id\":0,\"preferences\":{\"property1\":{},\"property2\":{}},\"references\":\"string\",\"reply_to\":\"string\",\"sender\":\"Agent\",\"sender_id\":0,\"subject\":\"string\",\"ticket_id\":0,\"time_unit\":0,\"to\":\"string\",\"type\":\"email\",\"type_id\":0,\"updated_at\":\"2019-08-24T14:15:22Z\",\"updated_by\":\"string\",\"updated_by_id\":0},\"article_count\":0,\"article_ids\":[0],\"articles\":[{\"attachments\":[{\"data\":\"string\",\"filename\":\"string\",\"id\":0,\"mime-type\":\"string\",\"preferences\":{\"property1\":\"string\",\"property2\":\"string\"},\"size\":\"string\"}],\"body\":\"string\",\"cc\":\"string\",\"content_type\":\"string\",\"created_at\":\"2019-08-24T14:15:22Z\",\"created_by\":\"string\",\"created_by_id\":0,\"from\":\"string\",\"id\":0,\"in_reply_to\":\"string\",\"internal\":true,\"message_id\":\"string\",\"message_id_md5\":\"string\",\"origin_by\":\"string\",\"origin_by_id\":0,\"preferences\":{\"property1\":{},\"property2\":{}},\"references\":\"string\",\"reply_to\":\"string\",\"sender\":\"Agent\",\"sender_id\":0,\"subject\":\"string\",\"ticket_id\":0,\"time_unit\":0,\"to\":\"string\",\"type\":\"email\",\"type_id\":0,\"updated_at\":\"2019-08-24T14:15:22Z\",\"updated_by\":\"string\",\"updated_by_id\":0}],\"attachments\":[{\"mimeType\":\"string\",\"name\":\"string\",\"uuid\":\"string\"}],\"close_at\":\"2019-08-24T14:15:22Z\",\"close_diff_in_min\":0,\"close_escalation_at\":\"2019-08-24T14:15:22Z\",\"close_in_min\":0,\"create_article_sender\":\"string\",\"create_article_sender_id\":0,\"create_article_type\":\"string\",\"create_article_type_id\":0,\"created_at\":\"2019-08-24T14:15:22Z\",\"created_by\":\"string\",\"created_by_id\":0,\"customer\":\"string\",\"customerContact\":{\"type\":\"USER\",\"uid\":\"string\",\"username\":\"string\",\"value\":\"string\"},\"customer_id\":\"string\",\"escalation_at\":\"2019-08-24T14:15:22Z\",\"first_response_at\":\"2019-08-24T14:15:22Z\",\"first_response_diff_in_min\":0,\"first_response_escalation_at\":\"2019-08-24T14:15:22Z\",\"first_response_in_min\":0,\"group\":\"string\",\"group_id\":0,\"id\":0,\"last_contact_agent_at\":\"2019-08-24T14:15:22Z\",\"last_contact_at\":\"2019-08-24T14:15:22Z\",\"last_contact_customer_at\":\"2019-08-24T14:15:22Z\",\"last_owner_update_at\":\"2019-08-24T14:15:22Z\",\"note\":\"string\",\"number\":\"string\",\"organization\":\"string\",\"organization_id\":0,\"owner\":\"string\",\"ownerContact\":{\"type\":\"USER\",\"uid\":\"string\",\"username\":\"string\",\"value\":\"string\"},\"owner_id\":0,\"pending_time\":\"2019-08-24T14:15:22Z\",\"priority\":\"1 low\",\"priority_id\":0,\"state\":\"new\",\"state_id\":0,\"t_agent_close_date\":\"2019-08-24T14:15:22Z\",\"t_agent_get_date\":\"2019-08-24T14:15:22Z\",\"t_call_link\":\"string\",\"t_create_call_uid\":\"string\",\"t_custom_01\":\"string\",\"t_custom_02\":\"string\",\"t_custom_03\":\"string\",\"t_custom_04\":\"string\",\"t_custom_05\":\"string\",\"t_custom_06\":\"string\",\"t_custom_07\":\"string\",\"t_custom_08\":\"string\",\"t_custom_09\":\"string\",\"t_custom_10\":\"string\",\"t_custom_11\":\"string\",\"t_custom_12\":\"string\",\"t_custom_13\":\"string\",\"t_custom_14\":\"string\",\"t_custom_15\":\"string\",\"t_custom_16\":\"string\",\"t_custom_17\":\"string\",\"t_custom_18\":\"string\",\"t_custom_19\":\"string\",\"t_custom_20\":\"string\",\"t_custom_21\":\"string\",\"t_custom_22\":\"string\",\"t_custom_23\":\"string\",\"t_custom_24\":\"string\",\"t_custom_25\":\"string\",\"t_custom_26\":\"string\",\"t_custom_27\":\"string\",\"t_custom_28\":\"string\",\"t_custom_29\":\"string\",\"t_custom_30\":\"string\",\"t_custom_31\":\"string\",\"t_custom_32\":\"string\",\"t_custom_33\":\"string\",\"t_custom_34\":\"string\",\"t_custom_35\":\"string\",\"t_custom_36\":\"string\",\"t_custom_37\":\"string\",\"t_custom_38\":\"string\",\"t_custom_39\":\"string\",\"t_custom_40\":\"string\",\"t_custom_41\":\"string\",\"t_custom_42\":\"string\",\"t_custom_43\":\"string\",\"t_custom_44\":\"string\",\"t_custom_45\":\"string\",\"t_custom_46\":\"string\",\"t_custom_47\":\"string\",\"t_custom_48\":\"string\",\"t_custom_49\":\"string\",\"t_custom_50\":\"string\",\"t_custom_51\":\"string\",\"t_custom_52\":\"string\",\"t_custom_53\":\"string\",\"t_custom_54\":\"string\",\"t_custom_55\":\"string\",\"t_custom_56\":\"string\",\"t_custom_57\":\"string\",\"t_custom_58\":\"string\",\"t_custom_59\":\"string\",\"t_custom_60\":\"string\",\"t_custom_61\":\"string\",\"t_custom_62\":\"string\",\"t_custom_63\":\"string\",\"t_custom_64\":\"string\",\"t_custom_65\":\"string\",\"t_custom_66\":\"string\",\"t_custom_67\":\"string\",\"t_custom_68\":\"string\",\"t_custom_69\":\"string\",\"t_custom_70\":\"string\",\"t_custom_71\":\"string\",\"t_custom_72\":\"string\",\"t_custom_73\":\"string\",\"t_custom_74\":\"string\",\"t_custom_75\":\"string\",\"t_custom_76\":\"string\",\"t_custom_77\":\"string\",\"t_custom_78\":\"string\",\"t_custom_79\":\"string\",\"t_custom_80\":\"string\",\"t_custom_81\":\"string\",\"t_custom_82\":\"string\",\"t_custom_83\":\"string\",\"t_custom_84\":\"string\",\"t_custom_85\":\"string\",\"t_custom_86\":\"string\",\"t_custom_87\":\"string\",\"t_custom_88\":\"string\",\"t_custom_89\":\"string\",\"t_custom_90\":\"string\",\"t_custom_91\":\"string\",\"t_custom_92\":\"string\",\"t_custom_93\":\"string\",\"t_custom_94\":\"string\",\"t_custom_95\":\"string\",\"t_custom_96\":\"string\",\"t_custom_97\":\"string\",\"t_custom_98\":\"string\",\"t_custom_99\":\"string\",\"t_custom_date_01\":\"2019-08-24T14:15:22Z\",\"t_custom_date_02\":\"2019-08-24T14:15:22Z\",\"t_custom_date_03\":\"2019-08-24T14:15:22Z\",\"t_custom_date_04\":\"2019-08-24T14:15:22Z\",\"t_custom_date_05\":\"2019-08-24T14:15:22Z\",\"t_custom_date_06\":\"2019-08-24T14:15:22Z\",\"t_custom_date_07\":\"2019-08-24T14:15:22Z\",\"t_custom_date_08\":\"2019-08-24T14:15:22Z\",\"t_custom_date_09\":\"2019-08-24T14:15:22Z\",\"t_custom_date_10\":\"2019-08-24T14:15:22Z\",\"t_custom_date_11\":\"2019-08-24T14:15:22Z\",\"t_custom_date_12\":\"2019-08-24T14:15:22Z\",\"t_custom_date_13\":\"2019-08-24T14:15:22Z\",\"t_custom_date_14\":\"2019-08-24T14:15:22Z\",\"t_custom_date_15\":\"2019-08-24T14:15:22Z\",\"t_custom_date_16\":\"2019-08-24T14:15:22Z\",\"t_custom_date_17\":\"2019-08-24T14:15:22Z\",\"t_custom_date_18\":\"2019-08-24T14:15:22Z\",\"t_custom_date_19\":\"2019-08-24T14:15:22Z\",\"t_custom_date_20\":\"2019-08-24T14:15:22Z\",\"t_custom_date_21\":\"2019-08-24T14:15:22Z\",\"t_custom_date_22\":\"2019-08-24T14:15:22Z\",\"t_custom_date_23\":\"2019-08-24T14:15:22Z\",\"t_custom_date_24\":\"2019-08-24T14:15:22Z\",\"t_custom_date_25\":\"2019-08-24T14:15:22Z\",\"t_custom_date_26\":\"2019-08-24T14:15:22Z\",\"t_custom_date_27\":\"2019-08-24T14:15:22Z\",\"t_custom_date_28\":\"2019-08-24T14:15:22Z\",\"t_custom_date_29\":\"2019-08-24T14:15:22Z\",\"t_custom_date_30\":\"2019-08-24T14:15:22Z\",\"t_custom_date_31\":\"2019-08-24T14:15:22Z\",\"t_custom_date_32\":\"2019-08-24T14:15:22Z\",\"t_custom_date_33\":\"2019-08-24T14:15:22Z\",\"t_custom_date_34\":\"2019-08-24T14:15:22Z\",\"t_custom_date_35\":\"2019-08-24T14:15:22Z\",\"t_custom_date_36\":\"2019-08-24T14:15:22Z\",\"t_custom_date_37\":\"2019-08-24T14:15:22Z\",\"t_custom_date_38\":\"2019-08-24T14:15:22Z\",\"t_custom_date_39\":\"2019-08-24T14:15:22Z\",\"t_custom_date_40\":\"2019-08-24T14:15:22Z\",\"t_custom_date_41\":\"2019-08-24T14:15:22Z\",\"t_custom_date_42\":\"2019-08-24T14:15:22Z\",\"t_custom_date_43\":\"2019-08-24T14:15:22Z\",\"t_custom_date_44\":\"2019-08-24T14:15:22Z\",\"t_custom_date_45\":\"2019-08-24T14:15:22Z\",\"t_custom_date_46\":\"2019-08-24T14:15:22Z\",\"t_custom_date_47\":\"2019-08-24T14:15:22Z\",\"t_custom_date_48\":\"2019-08-24T14:15:22Z\",\"t_custom_date_49\":\"2019-08-24T14:15:22Z\",\"t_external_ticketing_add\":true,\"t_external_ticketing_link\":\"string\",\"t_forgot_article_count\":0,\"t_forgot_time_unit\":0,\"t_is_child_link\":true,\"t_is_forgot_ticket\":true,\"t_is_normal_link\":true,\"t_is_parent_link\":true,\"t_is_view_by_owner\":true,\"t_knowledge_base_answer_link\":\"string\",\"t_knowledge_base_answer_uid\":\"string\",\"t_knowledge_base_category_link\":\"string\",\"t_knowledge_base_category_uid\":\"string\",\"t_knowledge_base_id_answer\":\"string\",\"t_knowledge_base_id_category\":\"string\",\"t_last_link_child_update\":\"string\",\"t_last_link_normal_update\":\"string\",\"t_last_link_with\":\"string\",\"t_last_merge_with\":\"string\",\"t_last_owner_view_at\":\"2019-08-24T14:15:22Z\",\"t_queue_type\":\"string\",\"t_reminder_cp_last_time\":\"2019-08-24T14:15:22Z\",\"t_reminder_cp_num\":0,\"t_reminder_tk_last_time\":\"2019-08-24T14:15:22Z\",\"t_reminder_tk_num\":0,\"t_reminder_tk_src\":\"string\",\"t_self_generated_ticket_call_final_state\":\"string\",\"t_self_generated_ticket_type\":\"string\",\"t_social_message_uid\":\"string\",\"t_state_last_update\":\"2019-08-24T14:15:22Z\",\"ticket_time_accounting\":[\"string\"],\"ticket_time_accounting_ids\":[0],\"time_unit\":0,\"title\":\"string\",\"type\":\"string\",\"update_diff_in_min\":0,\"update_escalation_at\":\"2019-08-24T14:15:22Z\",\"update_in_min\":0,\"updated_at\":\"2019-08-24T14:15:22Z\",\"updated_by\":\"string\",\"updated_by_id\":0}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = JSON.stringify({
"article": {
"attachments": [
{
"data": "string",
"filename": "string",
"id": 0,
"mime-type": "string",
"preferences": {
"property1": "string",
"property2": "string"
},
"size": "string"
}
],
"body": "string",
"cc": "string",
"content_type": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"created_by_id": 0,
"from": "string",
"id": 0,
"in_reply_to": "string",
"internal": true,
"message_id": "string",
"message_id_md5": "string",
"origin_by": "string",
"origin_by_id": 0,
"preferences": {
"property1": {},
"property2": {}
},
"references": "string",
"reply_to": "string",
"sender": "Agent",
"sender_id": 0,
"subject": "string",
"ticket_id": 0,
"time_unit": 0,
"to": "string",
"type": "email",
"type_id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"updated_by": "string",
"updated_by_id": 0
},
"article_count": 0,
"article_ids": [
0
],
"articles": [
{
"attachments": [
{
"data": "string",
"filename": "string",
"id": 0,
"mime-type": "string",
"preferences": {
"property1": "string",
"property2": "string"
},
"size": "string"
}
],
"body": "string",
"cc": "string",
"content_type": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"created_by_id": 0,
"from": "string",
"id": 0,
"in_reply_to": "string",
"internal": true,
"message_id": "string",
"message_id_md5": "string",
"origin_by": "string",
"origin_by_id": 0,
"preferences": {
"property1": {},
"property2": {}
},
"references": "string",
"reply_to": "string",
"sender": "Agent",
"sender_id": 0,
"subject": "string",
"ticket_id": 0,
"time_unit": 0,
"to": "string",
"type": "email",
"type_id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"updated_by": "string",
"updated_by_id": 0
}
],
"attachments": [
{
"mimeType": "string",
"name": "string",
"uuid": "string"
}
],
"close_at": "2019-08-24T14:15:22Z",
"close_diff_in_min": 0,
"close_escalation_at": "2019-08-24T14:15:22Z",
"close_in_min": 0,
"create_article_sender": "string",
"create_article_sender_id": 0,
"create_article_type": "string",
"create_article_type_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"created_by_id": 0,
"customer": "string",
"customerContact": {
"type": "USER",
"uid": "string",
"username": "string",
"value": "string"
},
"customer_id": "string",
"escalation_at": "2019-08-24T14:15:22Z",
"first_response_at": "2019-08-24T14:15:22Z",
"first_response_diff_in_min": 0,
"first_response_escalation_at": "2019-08-24T14:15:22Z",
"first_response_in_min": 0,
"group": "string",
"group_id": 0,
"id": 0,
"last_contact_agent_at": "2019-08-24T14:15:22Z",
"last_contact_at": "2019-08-24T14:15:22Z",
"last_contact_customer_at": "2019-08-24T14:15:22Z",
"last_owner_update_at": "2019-08-24T14:15:22Z",
"note": "string",
"number": "string",
"organization": "string",
"organization_id": 0,
"owner": "string",
"ownerContact": {
"type": "USER",
"uid": "string",
"username": "string",
"value": "string"
},
"owner_id": 0,
"pending_time": "2019-08-24T14:15:22Z",
"priority": "1 low",
"priority_id": 0,
"state": "new",
"state_id": 0,
"t_agent_close_date": "2019-08-24T14:15:22Z",
"t_agent_get_date": "2019-08-24T14:15:22Z",
"t_call_link": "string",
"t_create_call_uid": "string",
"t_custom_01": "string",
"t_custom_02": "string",
"t_custom_03": "string",
"t_custom_04": "string",
"t_custom_05": "string",
"t_custom_06": "string",
"t_custom_07": "string",
"t_custom_08": "string",
"t_custom_09": "string",
"t_custom_10": "string",
"t_custom_11": "string",
"t_custom_12": "string",
"t_custom_13": "string",
"t_custom_14": "string",
"t_custom_15": "string",
"t_custom_16": "string",
"t_custom_17": "string",
"t_custom_18": "string",
"t_custom_19": "string",
"t_custom_20": "string",
"t_custom_21": "string",
"t_custom_22": "string",
"t_custom_23": "string",
"t_custom_24": "string",
"t_custom_25": "string",
"t_custom_26": "string",
"t_custom_27": "string",
"t_custom_28": "string",
"t_custom_29": "string",
"t_custom_30": "string",
"t_custom_31": "string",
"t_custom_32": "string",
"t_custom_33": "string",
"t_custom_34": "string",
"t_custom_35": "string",
"t_custom_36": "string",
"t_custom_37": "string",
"t_custom_38": "string",
"t_custom_39": "string",
"t_custom_40": "string",
"t_custom_41": "string",
"t_custom_42": "string",
"t_custom_43": "string",
"t_custom_44": "string",
"t_custom_45": "string",
"t_custom_46": "string",
"t_custom_47": "string",
"t_custom_48": "string",
"t_custom_49": "string",
"t_custom_50": "string",
"t_custom_51": "string",
"t_custom_52": "string",
"t_custom_53": "string",
"t_custom_54": "string",
"t_custom_55": "string",
"t_custom_56": "string",
"t_custom_57": "string",
"t_custom_58": "string",
"t_custom_59": "string",
"t_custom_60": "string",
"t_custom_61": "string",
"t_custom_62": "string",
"t_custom_63": "string",
"t_custom_64": "string",
"t_custom_65": "string",
"t_custom_66": "string",
"t_custom_67": "string",
"t_custom_68": "string",
"t_custom_69": "string",
"t_custom_70": "string",
"t_custom_71": "string",
"t_custom_72": "string",
"t_custom_73": "string",
"t_custom_74": "string",
"t_custom_75": "string",
"t_custom_76": "string",
"t_custom_77": "string",
"t_custom_78": "string",
"t_custom_79": "string",
"t_custom_80": "string",
"t_custom_81": "string",
"t_custom_82": "string",
"t_custom_83": "string",
"t_custom_84": "string",
"t_custom_85": "string",
"t_custom_86": "string",
"t_custom_87": "string",
"t_custom_88": "string",
"t_custom_89": "string",
"t_custom_90": "string",
"t_custom_91": "string",
"t_custom_92": "string",
"t_custom_93": "string",
"t_custom_94": "string",
"t_custom_95": "string",
"t_custom_96": "string",
"t_custom_97": "string",
"t_custom_98": "string",
"t_custom_99": "string",
"t_custom_date_01": "2019-08-24T14:15:22Z",
"t_custom_date_02": "2019-08-24T14:15:22Z",
"t_custom_date_03": "2019-08-24T14:15:22Z",
"t_custom_date_04": "2019-08-24T14:15:22Z",
"t_custom_date_05": "2019-08-24T14:15:22Z",
"t_custom_date_06": "2019-08-24T14:15:22Z",
"t_custom_date_07": "2019-08-24T14:15:22Z",
"t_custom_date_08": "2019-08-24T14:15:22Z",
"t_custom_date_09": "2019-08-24T14:15:22Z",
"t_custom_date_10": "2019-08-24T14:15:22Z",
"t_custom_date_11": "2019-08-24T14:15:22Z",
"t_custom_date_12": "2019-08-24T14:15:22Z",
"t_custom_date_13": "2019-08-24T14:15:22Z",
"t_custom_date_14": "2019-08-24T14:15:22Z",
"t_custom_date_15": "2019-08-24T14:15:22Z",
"t_custom_date_16": "2019-08-24T14:15:22Z",
"t_custom_date_17": "2019-08-24T14:15:22Z",
"t_custom_date_18": "2019-08-24T14:15:22Z",
"t_custom_date_19": "2019-08-24T14:15:22Z",
"t_custom_date_20": "2019-08-24T14:15:22Z",
"t_custom_date_21": "2019-08-24T14:15:22Z",
"t_custom_date_22": "2019-08-24T14:15:22Z",
"t_custom_date_23": "2019-08-24T14:15:22Z",
"t_custom_date_24": "2019-08-24T14:15:22Z",
"t_custom_date_25": "2019-08-24T14:15:22Z",
"t_custom_date_26": "2019-08-24T14:15:22Z",
"t_custom_date_27": "2019-08-24T14:15:22Z",
"t_custom_date_28": "2019-08-24T14:15:22Z",
"t_custom_date_29": "2019-08-24T14:15:22Z",
"t_custom_date_30": "2019-08-24T14:15:22Z",
"t_custom_date_31": "2019-08-24T14:15:22Z",
"t_custom_date_32": "2019-08-24T14:15:22Z",
"t_custom_date_33": "2019-08-24T14:15:22Z",
"t_custom_date_34": "2019-08-24T14:15:22Z",
"t_custom_date_35": "2019-08-24T14:15:22Z",
"t_custom_date_36": "2019-08-24T14:15:22Z",
"t_custom_date_37": "2019-08-24T14:15:22Z",
"t_custom_date_38": "2019-08-24T14:15:22Z",
"t_custom_date_39": "2019-08-24T14:15:22Z",
"t_custom_date_40": "2019-08-24T14:15:22Z",
"t_custom_date_41": "2019-08-24T14:15:22Z",
"t_custom_date_42": "2019-08-24T14:15:22Z",
"t_custom_date_43": "2019-08-24T14:15:22Z",
"t_custom_date_44": "2019-08-24T14:15:22Z",
"t_custom_date_45": "2019-08-24T14:15:22Z",
"t_custom_date_46": "2019-08-24T14:15:22Z",
"t_custom_date_47": "2019-08-24T14:15:22Z",
"t_custom_date_48": "2019-08-24T14:15:22Z",
"t_custom_date_49": "2019-08-24T14:15:22Z",
"t_external_ticketing_add": true,
"t_external_ticketing_link": "string",
"t_forgot_article_count": 0,
"t_forgot_time_unit": 0,
"t_is_child_link": true,
"t_is_forgot_ticket": true,
"t_is_normal_link": true,
"t_is_parent_link": true,
"t_is_view_by_owner": true,
"t_knowledge_base_answer_link": "string",
"t_knowledge_base_answer_uid": "string",
"t_knowledge_base_category_link": "string",
"t_knowledge_base_category_uid": "string",
"t_knowledge_base_id_answer": "string",
"t_knowledge_base_id_category": "string",
"t_last_link_child_update": "string",
"t_last_link_normal_update": "string",
"t_last_link_with": "string",
"t_last_merge_with": "string",
"t_last_owner_view_at": "2019-08-24T14:15:22Z",
"t_queue_type": "string",
"t_reminder_cp_last_time": "2019-08-24T14:15:22Z",
"t_reminder_cp_num": 0,
"t_reminder_tk_last_time": "2019-08-24T14:15:22Z",
"t_reminder_tk_num": 0,
"t_reminder_tk_src": "string",
"t_self_generated_ticket_call_final_state": "string",
"t_self_generated_ticket_type": "string",
"t_social_message_uid": "string",
"t_state_last_update": "2019-08-24T14:15:22Z",
"ticket_time_accounting": [
"string"
],
"ticket_time_accounting_ids": [
0
],
"time_unit": 0,
"title": "string",
"type": "string",
"update_diff_in_min": 0,
"update_escalation_at": "2019-08-24T14:15:22Z",
"update_in_min": 0,
"updated_at": "2019-08-24T14:15:22Z",
"updated_by": "string",
"updated_by_id": 0
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("POST", "https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/IVR?submitterId=string");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "POST",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/support/ticket/IVR?submitterId=string",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
article: {
attachments: [
{
data: 'string',
filename: 'string',
id: 0,
'mime-type': 'string',
preferences: {property1: 'string', property2: 'string'},
size: 'string'
}
],
body: 'string',
cc: 'string',
content_type: 'string',
created_at: '2019-08-24T14:15:22Z',
created_by: 'string',
created_by_id: 0,
from: 'string',
id: 0,
in_reply_to: 'string',
internal: true,
message_id: 'string',
message_id_md5: 'string',
origin_by: 'string',
origin_by_id: 0,
preferences: {property1: {}, property2: {}},
references: 'string',
reply_to: 'string',
sender: 'Agent',
sender_id: 0,
subject: 'string',
ticket_id: 0,
time_unit: 0,
to: 'string',
type: 'email',
type_id: 0,
updated_at: '2019-08-24T14:15:22Z',
updated_by: 'string',
updated_by_id: 0
},
article_count: 0,
article_ids: [0],
articles: [
{
attachments: [
{
data: 'string',
filename: 'string',
id: 0,
'mime-type': 'string',
preferences: {property1: 'string', property2: 'string'},
size: 'string'
}
],
body: 'string',
cc: 'string',
content_type: 'string',
created_at: '2019-08-24T14:15:22Z',
created_by: 'string',
created_by_id: 0,
from: 'string',
id: 0,
in_reply_to: 'string',
internal: true,
message_id: 'string',
message_id_md5: 'string',
origin_by: 'string',
origin_by_id: 0,
preferences: {property1: {}, property2: {}},
references: 'string',
reply_to: 'string',
sender: 'Agent',
sender_id: 0,
subject: 'string',
ticket_id: 0,
time_unit: 0,
to: 'string',
type: 'email',
type_id: 0,
updated_at: '2019-08-24T14:15:22Z',
updated_by: 'string',
updated_by_id: 0
}
],
attachments: [{mimeType: 'string', name: 'string', uuid: 'string'}],
close_at: '2019-08-24T14:15:22Z',
close_diff_in_min: 0,
close_escalation_at: '2019-08-24T14:15:22Z',
close_in_min: 0,
create_article_sender: 'string',
create_article_sender_id: 0,
create_article_type: 'string',
create_article_type_id: 0,
created_at: '2019-08-24T14:15:22Z',
created_by: 'string',
created_by_id: 0,
customer: 'string',
customerContact: {type: 'USER', uid: 'string', username: 'string', value: 'string'},
customer_id: 'string',
escalation_at: '2019-08-24T14:15:22Z',
first_response_at: '2019-08-24T14:15:22Z',
first_response_diff_in_min: 0,
first_response_escalation_at: '2019-08-24T14:15:22Z',
first_response_in_min: 0,
group: 'string',
group_id: 0,
id: 0,
last_contact_agent_at: '2019-08-24T14:15:22Z',
last_contact_at: '2019-08-24T14:15:22Z',
last_contact_customer_at: '2019-08-24T14:15:22Z',
last_owner_update_at: '2019-08-24T14:15:22Z',
note: 'string',
number: 'string',
organization: 'string',
organization_id: 0,
owner: 'string',
ownerContact: {type: 'USER', uid: 'string', username: 'string', value: 'string'},
owner_id: 0,
pending_time: '2019-08-24T14:15:22Z',
priority: '1 low',
priority_id: 0,
state: 'new',
state_id: 0,
t_agent_close_date: '2019-08-24T14:15:22Z',
t_agent_get_date: '2019-08-24T14:15:22Z',
t_call_link: 'string',
t_create_call_uid: 'string',
t_custom_01: 'string',
t_custom_02: 'string',
t_custom_03: 'string',
t_custom_04: 'string',
t_custom_05: 'string',
t_custom_06: 'string',
t_custom_07: 'string',
t_custom_08: 'string',
t_custom_09: 'string',
t_custom_10: 'string',
t_custom_11: 'string',
t_custom_12: 'string',
t_custom_13: 'string',
t_custom_14: 'string',
t_custom_15: 'string',
t_custom_16: 'string',
t_custom_17: 'string',
t_custom_18: 'string',
t_custom_19: 'string',
t_custom_20: 'string',
t_custom_21: 'string',
t_custom_22: 'string',
t_custom_23: 'string',
t_custom_24: 'string',
t_custom_25: 'string',
t_custom_26: 'string',
t_custom_27: 'string',
t_custom_28: 'string',
t_custom_29: 'string',
t_custom_30: 'string',
t_custom_31: 'string',
t_custom_32: 'string',
t_custom_33: 'string',
t_custom_34: 'string',
t_custom_35: 'string',
t_custom_36: 'string',
t_custom_37: 'string',
t_custom_38: 'string',
t_custom_39: 'string',
t_custom_40: 'string',
t_custom_41: 'string',
t_custom_42: 'string',
t_custom_43: 'string',
t_custom_44: 'string',
t_custom_45: 'string',
t_custom_46: 'string',
t_custom_47: 'string',
t_custom_48: 'string',
t_custom_49: 'string',
t_custom_50: 'string',
t_custom_51: 'string',
t_custom_52: 'string',
t_custom_53: 'string',
t_custom_54: 'string',
t_custom_55: 'string',
t_custom_56: 'string',
t_custom_57: 'string',
t_custom_58: 'string',
t_custom_59: 'string',
t_custom_60: 'string',
t_custom_61: 'string',
t_custom_62: 'string',
t_custom_63: 'string',
t_custom_64: 'string',
t_custom_65: 'string',
t_custom_66: 'string',
t_custom_67: 'string',
t_custom_68: 'string',
t_custom_69: 'string',
t_custom_70: 'string',
t_custom_71: 'string',
t_custom_72: 'string',
t_custom_73: 'string',
t_custom_74: 'string',
t_custom_75: 'string',
t_custom_76: 'string',
t_custom_77: 'string',
t_custom_78: 'string',
t_custom_79: 'string',
t_custom_80: 'string',
t_custom_81: 'string',
t_custom_82: 'string',
t_custom_83: 'string',
t_custom_84: 'string',
t_custom_85: 'string',
t_custom_86: 'string',
t_custom_87: 'string',
t_custom_88: 'string',
t_custom_89: 'string',
t_custom_90: 'string',
t_custom_91: 'string',
t_custom_92: 'string',
t_custom_93: 'string',
t_custom_94: 'string',
t_custom_95: 'string',
t_custom_96: 'string',
t_custom_97: 'string',
t_custom_98: 'string',
t_custom_99: 'string',
t_custom_date_01: '2019-08-24T14:15:22Z',
t_custom_date_02: '2019-08-24T14:15:22Z',
t_custom_date_03: '2019-08-24T14:15:22Z',
t_custom_date_04: '2019-08-24T14:15:22Z',
t_custom_date_05: '2019-08-24T14:15:22Z',
t_custom_date_06: '2019-08-24T14:15:22Z',
t_custom_date_07: '2019-08-24T14:15:22Z',
t_custom_date_08: '2019-08-24T14:15:22Z',
t_custom_date_09: '2019-08-24T14:15:22Z',
t_custom_date_10: '2019-08-24T14:15:22Z',
t_custom_date_11: '2019-08-24T14:15:22Z',
t_custom_date_12: '2019-08-24T14:15:22Z',
t_custom_date_13: '2019-08-24T14:15:22Z',
t_custom_date_14: '2019-08-24T14:15:22Z',
t_custom_date_15: '2019-08-24T14:15:22Z',
t_custom_date_16: '2019-08-24T14:15:22Z',
t_custom_date_17: '2019-08-24T14:15:22Z',
t_custom_date_18: '2019-08-24T14:15:22Z',
t_custom_date_19: '2019-08-24T14:15:22Z',
t_custom_date_20: '2019-08-24T14:15:22Z',
t_custom_date_21: '2019-08-24T14:15:22Z',
t_custom_date_22: '2019-08-24T14:15:22Z',
t_custom_date_23: '2019-08-24T14:15:22Z',
t_custom_date_24: '2019-08-24T14:15:22Z',
t_custom_date_25: '2019-08-24T14:15:22Z',
t_custom_date_26: '2019-08-24T14:15:22Z',
t_custom_date_27: '2019-08-24T14:15:22Z',
t_custom_date_28: '2019-08-24T14:15:22Z',
t_custom_date_29: '2019-08-24T14:15:22Z',
t_custom_date_30: '2019-08-24T14:15:22Z',
t_custom_date_31: '2019-08-24T14:15:22Z',
t_custom_date_32: '2019-08-24T14:15:22Z',
t_custom_date_33: '2019-08-24T14:15:22Z',
t_custom_date_34: '2019-08-24T14:15:22Z',
t_custom_date_35: '2019-08-24T14:15:22Z',
t_custom_date_36: '2019-08-24T14:15:22Z',
t_custom_date_37: '2019-08-24T14:15:22Z',
t_custom_date_38: '2019-08-24T14:15:22Z',
t_custom_date_39: '2019-08-24T14:15:22Z',
t_custom_date_40: '2019-08-24T14:15:22Z',
t_custom_date_41: '2019-08-24T14:15:22Z',
t_custom_date_42: '2019-08-24T14:15:22Z',
t_custom_date_43: '2019-08-24T14:15:22Z',
t_custom_date_44: '2019-08-24T14:15:22Z',
t_custom_date_45: '2019-08-24T14:15:22Z',
t_custom_date_46: '2019-08-24T14:15:22Z',
t_custom_date_47: '2019-08-24T14:15:22Z',
t_custom_date_48: '2019-08-24T14:15:22Z',
t_custom_date_49: '2019-08-24T14:15:22Z',
t_external_ticketing_add: true,
t_external_ticketing_link: 'string',
t_forgot_article_count: 0,
t_forgot_time_unit: 0,
t_is_child_link: true,
t_is_forgot_ticket: true,
t_is_normal_link: true,
t_is_parent_link: true,
t_is_view_by_owner: true,
t_knowledge_base_answer_link: 'string',
t_knowledge_base_answer_uid: 'string',
t_knowledge_base_category_link: 'string',
t_knowledge_base_category_uid: 'string',
t_knowledge_base_id_answer: 'string',
t_knowledge_base_id_category: 'string',
t_last_link_child_update: 'string',
t_last_link_normal_update: 'string',
t_last_link_with: 'string',
t_last_merge_with: 'string',
t_last_owner_view_at: '2019-08-24T14:15:22Z',
t_queue_type: 'string',
t_reminder_cp_last_time: '2019-08-24T14:15:22Z',
t_reminder_cp_num: 0,
t_reminder_tk_last_time: '2019-08-24T14:15:22Z',
t_reminder_tk_num: 0,
t_reminder_tk_src: 'string',
t_self_generated_ticket_call_final_state: 'string',
t_self_generated_ticket_type: 'string',
t_social_message_uid: 'string',
t_state_last_update: '2019-08-24T14:15:22Z',
ticket_time_accounting: ['string'],
ticket_time_accounting_ids: [0],
time_unit: 0,
title: 'string',
type: 'string',
update_diff_in_min: 0,
update_escalation_at: '2019-08-24T14:15:22Z',
update_in_min: 0,
updated_at: '2019-08-24T14:15:22Z',
updated_by: 'string',
updated_by_id: 0
}));
req.end();
import http.client
conn = http.client.HTTPSConnection("")
payload = "{\"article\":{\"attachments\":[{\"data\":\"string\",\"filename\":\"string\",\"id\":0,\"mime-type\":\"string\",\"preferences\":{\"property1\":\"string\",\"property2\":\"string\"},\"size\":\"string\"}],\"body\":\"string\",\"cc\":\"string\",\"content_type\":\"string\",\"created_at\":\"2019-08-24T14:15:22Z\",\"created_by\":\"string\",\"created_by_id\":0,\"from\":\"string\",\"id\":0,\"in_reply_to\":\"string\",\"internal\":true,\"message_id\":\"string\",\"message_id_md5\":\"string\",\"origin_by\":\"string\",\"origin_by_id\":0,\"preferences\":{\"property1\":{},\"property2\":{}},\"references\":\"string\",\"reply_to\":\"string\",\"sender\":\"Agent\",\"sender_id\":0,\"subject\":\"string\",\"ticket_id\":0,\"time_unit\":0,\"to\":\"string\",\"type\":\"email\",\"type_id\":0,\"updated_at\":\"2019-08-24T14:15:22Z\",\"updated_by\":\"string\",\"updated_by_id\":0},\"article_count\":0,\"article_ids\":[0],\"articles\":[{\"attachments\":[{\"data\":\"string\",\"filename\":\"string\",\"id\":0,\"mime-type\":\"string\",\"preferences\":{\"property1\":\"string\",\"property2\":\"string\"},\"size\":\"string\"}],\"body\":\"string\",\"cc\":\"string\",\"content_type\":\"string\",\"created_at\":\"2019-08-24T14:15:22Z\",\"created_by\":\"string\",\"created_by_id\":0,\"from\":\"string\",\"id\":0,\"in_reply_to\":\"string\",\"internal\":true,\"message_id\":\"string\",\"message_id_md5\":\"string\",\"origin_by\":\"string\",\"origin_by_id\":0,\"preferences\":{\"property1\":{},\"property2\":{}},\"references\":\"string\",\"reply_to\":\"string\",\"sender\":\"Agent\",\"sender_id\":0,\"subject\":\"string\",\"ticket_id\":0,\"time_unit\":0,\"to\":\"string\",\"type\":\"email\",\"type_id\":0,\"updated_at\":\"2019-08-24T14:15:22Z\",\"updated_by\":\"string\",\"updated_by_id\":0}],\"attachments\":[{\"mimeType\":\"string\",\"name\":\"string\",\"uuid\":\"string\"}],\"close_at\":\"2019-08-24T14:15:22Z\",\"close_diff_in_min\":0,\"close_escalation_at\":\"2019-08-24T14:15:22Z\",\"close_in_min\":0,\"create_article_sender\":\"string\",\"create_article_sender_id\":0,\"create_article_type\":\"string\",\"create_article_type_id\":0,\"created_at\":\"2019-08-24T14:15:22Z\",\"created_by\":\"string\",\"created_by_id\":0,\"customer\":\"string\",\"customerContact\":{\"type\":\"USER\",\"uid\":\"string\",\"username\":\"string\",\"value\":\"string\"},\"customer_id\":\"string\",\"escalation_at\":\"2019-08-24T14:15:22Z\",\"first_response_at\":\"2019-08-24T14:15:22Z\",\"first_response_diff_in_min\":0,\"first_response_escalation_at\":\"2019-08-24T14:15:22Z\",\"first_response_in_min\":0,\"group\":\"string\",\"group_id\":0,\"id\":0,\"last_contact_agent_at\":\"2019-08-24T14:15:22Z\",\"last_contact_at\":\"2019-08-24T14:15:22Z\",\"last_contact_customer_at\":\"2019-08-24T14:15:22Z\",\"last_owner_update_at\":\"2019-08-24T14:15:22Z\",\"note\":\"string\",\"number\":\"string\",\"organization\":\"string\",\"organization_id\":0,\"owner\":\"string\",\"ownerContact\":{\"type\":\"USER\",\"uid\":\"string\",\"username\":\"string\",\"value\":\"string\"},\"owner_id\":0,\"pending_time\":\"2019-08-24T14:15:22Z\",\"priority\":\"1 low\",\"priority_id\":0,\"state\":\"new\",\"state_id\":0,\"t_agent_close_date\":\"2019-08-24T14:15:22Z\",\"t_agent_get_date\":\"2019-08-24T14:15:22Z\",\"t_call_link\":\"string\",\"t_create_call_uid\":\"string\",\"t_custom_01\":\"string\",\"t_custom_02\":\"string\",\"t_custom_03\":\"string\",\"t_custom_04\":\"string\",\"t_custom_05\":\"string\",\"t_custom_06\":\"string\",\"t_custom_07\":\"string\",\"t_custom_08\":\"string\",\"t_custom_09\":\"string\",\"t_custom_10\":\"string\",\"t_custom_11\":\"string\",\"t_custom_12\":\"string\",\"t_custom_13\":\"string\",\"t_custom_14\":\"string\",\"t_custom_15\":\"string\",\"t_custom_16\":\"string\",\"t_custom_17\":\"string\",\"t_custom_18\":\"string\",\"t_custom_19\":\"string\",\"t_custom_20\":\"string\",\"t_custom_21\":\"string\",\"t_custom_22\":\"string\",\"t_custom_23\":\"string\",\"t_custom_24\":\"string\",\"t_custom_25\":\"string\",\"t_custom_26\":\"string\",\"t_custom_27\":\"string\",\"t_custom_28\":\"string\",\"t_custom_29\":\"string\",\"t_custom_30\":\"string\",\"t_custom_31\":\"string\",\"t_custom_32\":\"string\",\"t_custom_33\":\"string\",\"t_custom_34\":\"string\",\"t_custom_35\":\"string\",\"t_custom_36\":\"string\",\"t_custom_37\":\"string\",\"t_custom_38\":\"string\",\"t_custom_39\":\"string\",\"t_custom_40\":\"string\",\"t_custom_41\":\"string\",\"t_custom_42\":\"string\",\"t_custom_43\":\"string\",\"t_custom_44\":\"string\",\"t_custom_45\":\"string\",\"t_custom_46\":\"string\",\"t_custom_47\":\"string\",\"t_custom_48\":\"string\",\"t_custom_49\":\"string\",\"t_custom_50\":\"string\",\"t_custom_51\":\"string\",\"t_custom_52\":\"string\",\"t_custom_53\":\"string\",\"t_custom_54\":\"string\",\"t_custom_55\":\"string\",\"t_custom_56\":\"string\",\"t_custom_57\":\"string\",\"t_custom_58\":\"string\",\"t_custom_59\":\"string\",\"t_custom_60\":\"string\",\"t_custom_61\":\"string\",\"t_custom_62\":\"string\",\"t_custom_63\":\"string\",\"t_custom_64\":\"string\",\"t_custom_65\":\"string\",\"t_custom_66\":\"string\",\"t_custom_67\":\"string\",\"t_custom_68\":\"string\",\"t_custom_69\":\"string\",\"t_custom_70\":\"string\",\"t_custom_71\":\"string\",\"t_custom_72\":\"string\",\"t_custom_73\":\"string\",\"t_custom_74\":\"string\",\"t_custom_75\":\"string\",\"t_custom_76\":\"string\",\"t_custom_77\":\"string\",\"t_custom_78\":\"string\",\"t_custom_79\":\"string\",\"t_custom_80\":\"string\",\"t_custom_81\":\"string\",\"t_custom_82\":\"string\",\"t_custom_83\":\"string\",\"t_custom_84\":\"string\",\"t_custom_85\":\"string\",\"t_custom_86\":\"string\",\"t_custom_87\":\"string\",\"t_custom_88\":\"string\",\"t_custom_89\":\"string\",\"t_custom_90\":\"string\",\"t_custom_91\":\"string\",\"t_custom_92\":\"string\",\"t_custom_93\":\"string\",\"t_custom_94\":\"string\",\"t_custom_95\":\"string\",\"t_custom_96\":\"string\",\"t_custom_97\":\"string\",\"t_custom_98\":\"string\",\"t_custom_99\":\"string\",\"t_custom_date_01\":\"2019-08-24T14:15:22Z\",\"t_custom_date_02\":\"2019-08-24T14:15:22Z\",\"t_custom_date_03\":\"2019-08-24T14:15:22Z\",\"t_custom_date_04\":\"2019-08-24T14:15:22Z\",\"t_custom_date_05\":\"2019-08-24T14:15:22Z\",\"t_custom_date_06\":\"2019-08-24T14:15:22Z\",\"t_custom_date_07\":\"2019-08-24T14:15:22Z\",\"t_custom_date_08\":\"2019-08-24T14:15:22Z\",\"t_custom_date_09\":\"2019-08-24T14:15:22Z\",\"t_custom_date_10\":\"2019-08-24T14:15:22Z\",\"t_custom_date_11\":\"2019-08-24T14:15:22Z\",\"t_custom_date_12\":\"2019-08-24T14:15:22Z\",\"t_custom_date_13\":\"2019-08-24T14:15:22Z\",\"t_custom_date_14\":\"2019-08-24T14:15:22Z\",\"t_custom_date_15\":\"2019-08-24T14:15:22Z\",\"t_custom_date_16\":\"2019-08-24T14:15:22Z\",\"t_custom_date_17\":\"2019-08-24T14:15:22Z\",\"t_custom_date_18\":\"2019-08-24T14:15:22Z\",\"t_custom_date_19\":\"2019-08-24T14:15:22Z\",\"t_custom_date_20\":\"2019-08-24T14:15:22Z\",\"t_custom_date_21\":\"2019-08-24T14:15:22Z\",\"t_custom_date_22\":\"2019-08-24T14:15:22Z\",\"t_custom_date_23\":\"2019-08-24T14:15:22Z\",\"t_custom_date_24\":\"2019-08-24T14:15:22Z\",\"t_custom_date_25\":\"2019-08-24T14:15:22Z\",\"t_custom_date_26\":\"2019-08-24T14:15:22Z\",\"t_custom_date_27\":\"2019-08-24T14:15:22Z\",\"t_custom_date_28\":\"2019-08-24T14:15:22Z\",\"t_custom_date_29\":\"2019-08-24T14:15:22Z\",\"t_custom_date_30\":\"2019-08-24T14:15:22Z\",\"t_custom_date_31\":\"2019-08-24T14:15:22Z\",\"t_custom_date_32\":\"2019-08-24T14:15:22Z\",\"t_custom_date_33\":\"2019-08-24T14:15:22Z\",\"t_custom_date_34\":\"2019-08-24T14:15:22Z\",\"t_custom_date_35\":\"2019-08-24T14:15:22Z\",\"t_custom_date_36\":\"2019-08-24T14:15:22Z\",\"t_custom_date_37\":\"2019-08-24T14:15:22Z\",\"t_custom_date_38\":\"2019-08-24T14:15:22Z\",\"t_custom_date_39\":\"2019-08-24T14:15:22Z\",\"t_custom_date_40\":\"2019-08-24T14:15:22Z\",\"t_custom_date_41\":\"2019-08-24T14:15:22Z\",\"t_custom_date_42\":\"2019-08-24T14:15:22Z\",\"t_custom_date_43\":\"2019-08-24T14:15:22Z\",\"t_custom_date_44\":\"2019-08-24T14:15:22Z\",\"t_custom_date_45\":\"2019-08-24T14:15:22Z\",\"t_custom_date_46\":\"2019-08-24T14:15:22Z\",\"t_custom_date_47\":\"2019-08-24T14:15:22Z\",\"t_custom_date_48\":\"2019-08-24T14:15:22Z\",\"t_custom_date_49\":\"2019-08-24T14:15:22Z\",\"t_external_ticketing_add\":true,\"t_external_ticketing_link\":\"string\",\"t_forgot_article_count\":0,\"t_forgot_time_unit\":0,\"t_is_child_link\":true,\"t_is_forgot_ticket\":true,\"t_is_normal_link\":true,\"t_is_parent_link\":true,\"t_is_view_by_owner\":true,\"t_knowledge_base_answer_link\":\"string\",\"t_knowledge_base_answer_uid\":\"string\",\"t_knowledge_base_category_link\":\"string\",\"t_knowledge_base_category_uid\":\"string\",\"t_knowledge_base_id_answer\":\"string\",\"t_knowledge_base_id_category\":\"string\",\"t_last_link_child_update\":\"string\",\"t_last_link_normal_update\":\"string\",\"t_last_link_with\":\"string\",\"t_last_merge_with\":\"string\",\"t_last_owner_view_at\":\"2019-08-24T14:15:22Z\",\"t_queue_type\":\"string\",\"t_reminder_cp_last_time\":\"2019-08-24T14:15:22Z\",\"t_reminder_cp_num\":0,\"t_reminder_tk_last_time\":\"2019-08-24T14:15:22Z\",\"t_reminder_tk_num\":0,\"t_reminder_tk_src\":\"string\",\"t_self_generated_ticket_call_final_state\":\"string\",\"t_self_generated_ticket_type\":\"string\",\"t_social_message_uid\":\"string\",\"t_state_last_update\":\"2019-08-24T14:15:22Z\",\"ticket_time_accounting\":[\"string\"],\"ticket_time_accounting_ids\":[0],\"time_unit\":0,\"title\":\"string\",\"type\":\"string\",\"update_diff_in_min\":0,\"update_escalation_at\":\"2019-08-24T14:15:22Z\",\"update_in_min\":0,\"updated_at\":\"2019-08-24T14:15:22Z\",\"updated_by\":\"string\",\"updated_by_id\":0}"
headers = {
'Content-Type': "application/json",
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("POST", "%3CTVOX_HOST%3E/tvox/rest/support/ticket/IVR?submitterId=string", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/IVR?submitterId=string")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
request.body = "{\"article\":{\"attachments\":[{\"data\":\"string\",\"filename\":\"string\",\"id\":0,\"mime-type\":\"string\",\"preferences\":{\"property1\":\"string\",\"property2\":\"string\"},\"size\":\"string\"}],\"body\":\"string\",\"cc\":\"string\",\"content_type\":\"string\",\"created_at\":\"2019-08-24T14:15:22Z\",\"created_by\":\"string\",\"created_by_id\":0,\"from\":\"string\",\"id\":0,\"in_reply_to\":\"string\",\"internal\":true,\"message_id\":\"string\",\"message_id_md5\":\"string\",\"origin_by\":\"string\",\"origin_by_id\":0,\"preferences\":{\"property1\":{},\"property2\":{}},\"references\":\"string\",\"reply_to\":\"string\",\"sender\":\"Agent\",\"sender_id\":0,\"subject\":\"string\",\"ticket_id\":0,\"time_unit\":0,\"to\":\"string\",\"type\":\"email\",\"type_id\":0,\"updated_at\":\"2019-08-24T14:15:22Z\",\"updated_by\":\"string\",\"updated_by_id\":0},\"article_count\":0,\"article_ids\":[0],\"articles\":[{\"attachments\":[{\"data\":\"string\",\"filename\":\"string\",\"id\":0,\"mime-type\":\"string\",\"preferences\":{\"property1\":\"string\",\"property2\":\"string\"},\"size\":\"string\"}],\"body\":\"string\",\"cc\":\"string\",\"content_type\":\"string\",\"created_at\":\"2019-08-24T14:15:22Z\",\"created_by\":\"string\",\"created_by_id\":0,\"from\":\"string\",\"id\":0,\"in_reply_to\":\"string\",\"internal\":true,\"message_id\":\"string\",\"message_id_md5\":\"string\",\"origin_by\":\"string\",\"origin_by_id\":0,\"preferences\":{\"property1\":{},\"property2\":{}},\"references\":\"string\",\"reply_to\":\"string\",\"sender\":\"Agent\",\"sender_id\":0,\"subject\":\"string\",\"ticket_id\":0,\"time_unit\":0,\"to\":\"string\",\"type\":\"email\",\"type_id\":0,\"updated_at\":\"2019-08-24T14:15:22Z\",\"updated_by\":\"string\",\"updated_by_id\":0}],\"attachments\":[{\"mimeType\":\"string\",\"name\":\"string\",\"uuid\":\"string\"}],\"close_at\":\"2019-08-24T14:15:22Z\",\"close_diff_in_min\":0,\"close_escalation_at\":\"2019-08-24T14:15:22Z\",\"close_in_min\":0,\"create_article_sender\":\"string\",\"create_article_sender_id\":0,\"create_article_type\":\"string\",\"create_article_type_id\":0,\"created_at\":\"2019-08-24T14:15:22Z\",\"created_by\":\"string\",\"created_by_id\":0,\"customer\":\"string\",\"customerContact\":{\"type\":\"USER\",\"uid\":\"string\",\"username\":\"string\",\"value\":\"string\"},\"customer_id\":\"string\",\"escalation_at\":\"2019-08-24T14:15:22Z\",\"first_response_at\":\"2019-08-24T14:15:22Z\",\"first_response_diff_in_min\":0,\"first_response_escalation_at\":\"2019-08-24T14:15:22Z\",\"first_response_in_min\":0,\"group\":\"string\",\"group_id\":0,\"id\":0,\"last_contact_agent_at\":\"2019-08-24T14:15:22Z\",\"last_contact_at\":\"2019-08-24T14:15:22Z\",\"last_contact_customer_at\":\"2019-08-24T14:15:22Z\",\"last_owner_update_at\":\"2019-08-24T14:15:22Z\",\"note\":\"string\",\"number\":\"string\",\"organization\":\"string\",\"organization_id\":0,\"owner\":\"string\",\"ownerContact\":{\"type\":\"USER\",\"uid\":\"string\",\"username\":\"string\",\"value\":\"string\"},\"owner_id\":0,\"pending_time\":\"2019-08-24T14:15:22Z\",\"priority\":\"1 low\",\"priority_id\":0,\"state\":\"new\",\"state_id\":0,\"t_agent_close_date\":\"2019-08-24T14:15:22Z\",\"t_agent_get_date\":\"2019-08-24T14:15:22Z\",\"t_call_link\":\"string\",\"t_create_call_uid\":\"string\",\"t_custom_01\":\"string\",\"t_custom_02\":\"string\",\"t_custom_03\":\"string\",\"t_custom_04\":\"string\",\"t_custom_05\":\"string\",\"t_custom_06\":\"string\",\"t_custom_07\":\"string\",\"t_custom_08\":\"string\",\"t_custom_09\":\"string\",\"t_custom_10\":\"string\",\"t_custom_11\":\"string\",\"t_custom_12\":\"string\",\"t_custom_13\":\"string\",\"t_custom_14\":\"string\",\"t_custom_15\":\"string\",\"t_custom_16\":\"string\",\"t_custom_17\":\"string\",\"t_custom_18\":\"string\",\"t_custom_19\":\"string\",\"t_custom_20\":\"string\",\"t_custom_21\":\"string\",\"t_custom_22\":\"string\",\"t_custom_23\":\"string\",\"t_custom_24\":\"string\",\"t_custom_25\":\"string\",\"t_custom_26\":\"string\",\"t_custom_27\":\"string\",\"t_custom_28\":\"string\",\"t_custom_29\":\"string\",\"t_custom_30\":\"string\",\"t_custom_31\":\"string\",\"t_custom_32\":\"string\",\"t_custom_33\":\"string\",\"t_custom_34\":\"string\",\"t_custom_35\":\"string\",\"t_custom_36\":\"string\",\"t_custom_37\":\"string\",\"t_custom_38\":\"string\",\"t_custom_39\":\"string\",\"t_custom_40\":\"string\",\"t_custom_41\":\"string\",\"t_custom_42\":\"string\",\"t_custom_43\":\"string\",\"t_custom_44\":\"string\",\"t_custom_45\":\"string\",\"t_custom_46\":\"string\",\"t_custom_47\":\"string\",\"t_custom_48\":\"string\",\"t_custom_49\":\"string\",\"t_custom_50\":\"string\",\"t_custom_51\":\"string\",\"t_custom_52\":\"string\",\"t_custom_53\":\"string\",\"t_custom_54\":\"string\",\"t_custom_55\":\"string\",\"t_custom_56\":\"string\",\"t_custom_57\":\"string\",\"t_custom_58\":\"string\",\"t_custom_59\":\"string\",\"t_custom_60\":\"string\",\"t_custom_61\":\"string\",\"t_custom_62\":\"string\",\"t_custom_63\":\"string\",\"t_custom_64\":\"string\",\"t_custom_65\":\"string\",\"t_custom_66\":\"string\",\"t_custom_67\":\"string\",\"t_custom_68\":\"string\",\"t_custom_69\":\"string\",\"t_custom_70\":\"string\",\"t_custom_71\":\"string\",\"t_custom_72\":\"string\",\"t_custom_73\":\"string\",\"t_custom_74\":\"string\",\"t_custom_75\":\"string\",\"t_custom_76\":\"string\",\"t_custom_77\":\"string\",\"t_custom_78\":\"string\",\"t_custom_79\":\"string\",\"t_custom_80\":\"string\",\"t_custom_81\":\"string\",\"t_custom_82\":\"string\",\"t_custom_83\":\"string\",\"t_custom_84\":\"string\",\"t_custom_85\":\"string\",\"t_custom_86\":\"string\",\"t_custom_87\":\"string\",\"t_custom_88\":\"string\",\"t_custom_89\":\"string\",\"t_custom_90\":\"string\",\"t_custom_91\":\"string\",\"t_custom_92\":\"string\",\"t_custom_93\":\"string\",\"t_custom_94\":\"string\",\"t_custom_95\":\"string\",\"t_custom_96\":\"string\",\"t_custom_97\":\"string\",\"t_custom_98\":\"string\",\"t_custom_99\":\"string\",\"t_custom_date_01\":\"2019-08-24T14:15:22Z\",\"t_custom_date_02\":\"2019-08-24T14:15:22Z\",\"t_custom_date_03\":\"2019-08-24T14:15:22Z\",\"t_custom_date_04\":\"2019-08-24T14:15:22Z\",\"t_custom_date_05\":\"2019-08-24T14:15:22Z\",\"t_custom_date_06\":\"2019-08-24T14:15:22Z\",\"t_custom_date_07\":\"2019-08-24T14:15:22Z\",\"t_custom_date_08\":\"2019-08-24T14:15:22Z\",\"t_custom_date_09\":\"2019-08-24T14:15:22Z\",\"t_custom_date_10\":\"2019-08-24T14:15:22Z\",\"t_custom_date_11\":\"2019-08-24T14:15:22Z\",\"t_custom_date_12\":\"2019-08-24T14:15:22Z\",\"t_custom_date_13\":\"2019-08-24T14:15:22Z\",\"t_custom_date_14\":\"2019-08-24T14:15:22Z\",\"t_custom_date_15\":\"2019-08-24T14:15:22Z\",\"t_custom_date_16\":\"2019-08-24T14:15:22Z\",\"t_custom_date_17\":\"2019-08-24T14:15:22Z\",\"t_custom_date_18\":\"2019-08-24T14:15:22Z\",\"t_custom_date_19\":\"2019-08-24T14:15:22Z\",\"t_custom_date_20\":\"2019-08-24T14:15:22Z\",\"t_custom_date_21\":\"2019-08-24T14:15:22Z\",\"t_custom_date_22\":\"2019-08-24T14:15:22Z\",\"t_custom_date_23\":\"2019-08-24T14:15:22Z\",\"t_custom_date_24\":\"2019-08-24T14:15:22Z\",\"t_custom_date_25\":\"2019-08-24T14:15:22Z\",\"t_custom_date_26\":\"2019-08-24T14:15:22Z\",\"t_custom_date_27\":\"2019-08-24T14:15:22Z\",\"t_custom_date_28\":\"2019-08-24T14:15:22Z\",\"t_custom_date_29\":\"2019-08-24T14:15:22Z\",\"t_custom_date_30\":\"2019-08-24T14:15:22Z\",\"t_custom_date_31\":\"2019-08-24T14:15:22Z\",\"t_custom_date_32\":\"2019-08-24T14:15:22Z\",\"t_custom_date_33\":\"2019-08-24T14:15:22Z\",\"t_custom_date_34\":\"2019-08-24T14:15:22Z\",\"t_custom_date_35\":\"2019-08-24T14:15:22Z\",\"t_custom_date_36\":\"2019-08-24T14:15:22Z\",\"t_custom_date_37\":\"2019-08-24T14:15:22Z\",\"t_custom_date_38\":\"2019-08-24T14:15:22Z\",\"t_custom_date_39\":\"2019-08-24T14:15:22Z\",\"t_custom_date_40\":\"2019-08-24T14:15:22Z\",\"t_custom_date_41\":\"2019-08-24T14:15:22Z\",\"t_custom_date_42\":\"2019-08-24T14:15:22Z\",\"t_custom_date_43\":\"2019-08-24T14:15:22Z\",\"t_custom_date_44\":\"2019-08-24T14:15:22Z\",\"t_custom_date_45\":\"2019-08-24T14:15:22Z\",\"t_custom_date_46\":\"2019-08-24T14:15:22Z\",\"t_custom_date_47\":\"2019-08-24T14:15:22Z\",\"t_custom_date_48\":\"2019-08-24T14:15:22Z\",\"t_custom_date_49\":\"2019-08-24T14:15:22Z\",\"t_external_ticketing_add\":true,\"t_external_ticketing_link\":\"string\",\"t_forgot_article_count\":0,\"t_forgot_time_unit\":0,\"t_is_child_link\":true,\"t_is_forgot_ticket\":true,\"t_is_normal_link\":true,\"t_is_parent_link\":true,\"t_is_view_by_owner\":true,\"t_knowledge_base_answer_link\":\"string\",\"t_knowledge_base_answer_uid\":\"string\",\"t_knowledge_base_category_link\":\"string\",\"t_knowledge_base_category_uid\":\"string\",\"t_knowledge_base_id_answer\":\"string\",\"t_knowledge_base_id_category\":\"string\",\"t_last_link_child_update\":\"string\",\"t_last_link_normal_update\":\"string\",\"t_last_link_with\":\"string\",\"t_last_merge_with\":\"string\",\"t_last_owner_view_at\":\"2019-08-24T14:15:22Z\",\"t_queue_type\":\"string\",\"t_reminder_cp_last_time\":\"2019-08-24T14:15:22Z\",\"t_reminder_cp_num\":0,\"t_reminder_tk_last_time\":\"2019-08-24T14:15:22Z\",\"t_reminder_tk_num\":0,\"t_reminder_tk_src\":\"string\",\"t_self_generated_ticket_call_final_state\":\"string\",\"t_self_generated_ticket_type\":\"string\",\"t_social_message_uid\":\"string\",\"t_state_last_update\":\"2019-08-24T14:15:22Z\",\"ticket_time_accounting\":[\"string\"],\"ticket_time_accounting_ids\":[0],\"time_unit\":0,\"title\":\"string\",\"type\":\"string\",\"update_diff_in_min\":0,\"update_escalation_at\":\"2019-08-24T14:15:22Z\",\"update_in_min\":0,\"updated_at\":\"2019-08-24T14:15:22Z\",\"updated_by\":\"string\",\"updated_by_id\":0}"
response = http.request(request)
puts response.read_body
POST /rest/support/ticket/{context}
Create a new ticket by choosing the appropriate context and providing contact information in addition to the ticket details
Parameters
Body parameter
{
"article": {
"attachments": [
{
"data": "string",
"filename": "string",
"id": 0,
"mime-type": "string",
"preferences": {
"property1": "string",
"property2": "string"
},
"size": "string"
}
],
"body": "string",
"cc": "string",
"content_type": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"created_by_id": 0,
"from": "string",
"id": 0,
"in_reply_to": "string",
"internal": true,
"message_id": "string",
"message_id_md5": "string",
"origin_by": "string",
"origin_by_id": 0,
"preferences": {
"property1": {},
"property2": {}
},
"references": "string",
"reply_to": "string",
"sender": "Agent",
"sender_id": 0,
"subject": "string",
"ticket_id": 0,
"time_unit": 0,
"to": "string",
"type": "email",
"type_id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"updated_by": "string",
"updated_by_id": 0
},
"article_count": 0,
"article_ids": [
0
],
"articles": [
{
"attachments": [
{
"data": "string",
"filename": "string",
"id": 0,
"mime-type": "string",
"preferences": {
"property1": "string",
"property2": "string"
},
"size": "string"
}
],
"body": "string",
"cc": "string",
"content_type": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"created_by_id": 0,
"from": "string",
"id": 0,
"in_reply_to": "string",
"internal": true,
"message_id": "string",
"message_id_md5": "string",
"origin_by": "string",
"origin_by_id": 0,
"preferences": {
"property1": {},
"property2": {}
},
"references": "string",
"reply_to": "string",
"sender": "Agent",
"sender_id": 0,
"subject": "string",
"ticket_id": 0,
"time_unit": 0,
"to": "string",
"type": "email",
"type_id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"updated_by": "string",
"updated_by_id": 0
}
],
"attachments": [
{
"mimeType": "string",
"name": "string",
"uuid": "string"
}
],
"close_at": "2019-08-24T14:15:22Z",
"close_diff_in_min": 0,
"close_escalation_at": "2019-08-24T14:15:22Z",
"close_in_min": 0,
"create_article_sender": "string",
"create_article_sender_id": 0,
"create_article_type": "string",
"create_article_type_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"created_by_id": 0,
"customer": "string",
"customerContact": {
"type": "USER",
"uid": "string",
"username": "string",
"value": "string"
},
"customer_id": "string",
"escalation_at": "2019-08-24T14:15:22Z",
"first_response_at": "2019-08-24T14:15:22Z",
"first_response_diff_in_min": 0,
"first_response_escalation_at": "2019-08-24T14:15:22Z",
"first_response_in_min": 0,
"group": "string",
"group_id": 0,
"id": 0,
"last_contact_agent_at": "2019-08-24T14:15:22Z",
"last_contact_at": "2019-08-24T14:15:22Z",
"last_contact_customer_at": "2019-08-24T14:15:22Z",
"last_owner_update_at": "2019-08-24T14:15:22Z",
"note": "string",
"number": "string",
"organization": "string",
"organization_id": 0,
"owner": "string",
"ownerContact": {
"type": "USER",
"uid": "string",
"username": "string",
"value": "string"
},
"owner_id": 0,
"pending_time": "2019-08-24T14:15:22Z",
"priority": "1 low",
"priority_id": 0,
"state": "new",
"state_id": 0,
"t_agent_close_date": "2019-08-24T14:15:22Z",
"t_agent_get_date": "2019-08-24T14:15:22Z",
"t_call_link": "string",
"t_create_call_uid": "string",
"t_custom_01": "string",
"t_custom_02": "string",
"t_custom_03": "string",
"t_custom_04": "string",
"t_custom_05": "string",
"t_custom_06": "string",
"t_custom_07": "string",
"t_custom_08": "string",
"t_custom_09": "string",
"t_custom_10": "string",
"t_custom_11": "string",
"t_custom_12": "string",
"t_custom_13": "string",
"t_custom_14": "string",
"t_custom_15": "string",
"t_custom_16": "string",
"t_custom_17": "string",
"t_custom_18": "string",
"t_custom_19": "string",
"t_custom_20": "string",
"t_custom_21": "string",
"t_custom_22": "string",
"t_custom_23": "string",
"t_custom_24": "string",
"t_custom_25": "string",
"t_custom_26": "string",
"t_custom_27": "string",
"t_custom_28": "string",
"t_custom_29": "string",
"t_custom_30": "string",
"t_custom_31": "string",
"t_custom_32": "string",
"t_custom_33": "string",
"t_custom_34": "string",
"t_custom_35": "string",
"t_custom_36": "string",
"t_custom_37": "string",
"t_custom_38": "string",
"t_custom_39": "string",
"t_custom_40": "string",
"t_custom_41": "string",
"t_custom_42": "string",
"t_custom_43": "string",
"t_custom_44": "string",
"t_custom_45": "string",
"t_custom_46": "string",
"t_custom_47": "string",
"t_custom_48": "string",
"t_custom_49": "string",
"t_custom_50": "string",
"t_custom_51": "string",
"t_custom_52": "string",
"t_custom_53": "string",
"t_custom_54": "string",
"t_custom_55": "string",
"t_custom_56": "string",
"t_custom_57": "string",
"t_custom_58": "string",
"t_custom_59": "string",
"t_custom_60": "string",
"t_custom_61": "string",
"t_custom_62": "string",
"t_custom_63": "string",
"t_custom_64": "string",
"t_custom_65": "string",
"t_custom_66": "string",
"t_custom_67": "string",
"t_custom_68": "string",
"t_custom_69": "string",
"t_custom_70": "string",
"t_custom_71": "string",
"t_custom_72": "string",
"t_custom_73": "string",
"t_custom_74": "string",
"t_custom_75": "string",
"t_custom_76": "string",
"t_custom_77": "string",
"t_custom_78": "string",
"t_custom_79": "string",
"t_custom_80": "string",
"t_custom_81": "string",
"t_custom_82": "string",
"t_custom_83": "string",
"t_custom_84": "string",
"t_custom_85": "string",
"t_custom_86": "string",
"t_custom_87": "string",
"t_custom_88": "string",
"t_custom_89": "string",
"t_custom_90": "string",
"t_custom_91": "string",
"t_custom_92": "string",
"t_custom_93": "string",
"t_custom_94": "string",
"t_custom_95": "string",
"t_custom_96": "string",
"t_custom_97": "string",
"t_custom_98": "string",
"t_custom_99": "string",
"t_custom_date_01": "2019-08-24T14:15:22Z",
"t_custom_date_02": "2019-08-24T14:15:22Z",
"t_custom_date_03": "2019-08-24T14:15:22Z",
"t_custom_date_04": "2019-08-24T14:15:22Z",
"t_custom_date_05": "2019-08-24T14:15:22Z",
"t_custom_date_06": "2019-08-24T14:15:22Z",
"t_custom_date_07": "2019-08-24T14:15:22Z",
"t_custom_date_08": "2019-08-24T14:15:22Z",
"t_custom_date_09": "2019-08-24T14:15:22Z",
"t_custom_date_10": "2019-08-24T14:15:22Z",
"t_custom_date_11": "2019-08-24T14:15:22Z",
"t_custom_date_12": "2019-08-24T14:15:22Z",
"t_custom_date_13": "2019-08-24T14:15:22Z",
"t_custom_date_14": "2019-08-24T14:15:22Z",
"t_custom_date_15": "2019-08-24T14:15:22Z",
"t_custom_date_16": "2019-08-24T14:15:22Z",
"t_custom_date_17": "2019-08-24T14:15:22Z",
"t_custom_date_18": "2019-08-24T14:15:22Z",
"t_custom_date_19": "2019-08-24T14:15:22Z",
"t_custom_date_20": "2019-08-24T14:15:22Z",
"t_custom_date_21": "2019-08-24T14:15:22Z",
"t_custom_date_22": "2019-08-24T14:15:22Z",
"t_custom_date_23": "2019-08-24T14:15:22Z",
"t_custom_date_24": "2019-08-24T14:15:22Z",
"t_custom_date_25": "2019-08-24T14:15:22Z",
"t_custom_date_26": "2019-08-24T14:15:22Z",
"t_custom_date_27": "2019-08-24T14:15:22Z",
"t_custom_date_28": "2019-08-24T14:15:22Z",
"t_custom_date_29": "2019-08-24T14:15:22Z",
"t_custom_date_30": "2019-08-24T14:15:22Z",
"t_custom_date_31": "2019-08-24T14:15:22Z",
"t_custom_date_32": "2019-08-24T14:15:22Z",
"t_custom_date_33": "2019-08-24T14:15:22Z",
"t_custom_date_34": "2019-08-24T14:15:22Z",
"t_custom_date_35": "2019-08-24T14:15:22Z",
"t_custom_date_36": "2019-08-24T14:15:22Z",
"t_custom_date_37": "2019-08-24T14:15:22Z",
"t_custom_date_38": "2019-08-24T14:15:22Z",
"t_custom_date_39": "2019-08-24T14:15:22Z",
"t_custom_date_40": "2019-08-24T14:15:22Z",
"t_custom_date_41": "2019-08-24T14:15:22Z",
"t_custom_date_42": "2019-08-24T14:15:22Z",
"t_custom_date_43": "2019-08-24T14:15:22Z",
"t_custom_date_44": "2019-08-24T14:15:22Z",
"t_custom_date_45": "2019-08-24T14:15:22Z",
"t_custom_date_46": "2019-08-24T14:15:22Z",
"t_custom_date_47": "2019-08-24T14:15:22Z",
"t_custom_date_48": "2019-08-24T14:15:22Z",
"t_custom_date_49": "2019-08-24T14:15:22Z",
"t_external_ticketing_add": true,
"t_external_ticketing_link": "string",
"t_forgot_article_count": 0,
"t_forgot_time_unit": 0,
"t_is_child_link": true,
"t_is_forgot_ticket": true,
"t_is_normal_link": true,
"t_is_parent_link": true,
"t_is_view_by_owner": true,
"t_knowledge_base_answer_link": "string",
"t_knowledge_base_answer_uid": "string",
"t_knowledge_base_category_link": "string",
"t_knowledge_base_category_uid": "string",
"t_knowledge_base_id_answer": "string",
"t_knowledge_base_id_category": "string",
"t_last_link_child_update": "string",
"t_last_link_normal_update": "string",
"t_last_link_with": "string",
"t_last_merge_with": "string",
"t_last_owner_view_at": "2019-08-24T14:15:22Z",
"t_queue_type": "string",
"t_reminder_cp_last_time": "2019-08-24T14:15:22Z",
"t_reminder_cp_num": 0,
"t_reminder_tk_last_time": "2019-08-24T14:15:22Z",
"t_reminder_tk_num": 0,
"t_reminder_tk_src": "string",
"t_self_generated_ticket_call_final_state": "string",
"t_self_generated_ticket_type": "string",
"t_social_message_uid": "string",
"t_state_last_update": "2019-08-24T14:15:22Z",
"ticket_time_accounting": [
"string"
],
"ticket_time_accounting_ids": [
0
],
"time_unit": 0,
"title": "string",
"type": "string",
"update_diff_in_min": 0,
"update_escalation_at": "2019-08-24T14:15:22Z",
"update_in_min": 0,
"updated_at": "2019-08-24T14:15:22Z",
"updated_by": "string",
"updated_by_id": 0
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| context | path | string | true | Ticket context |
| submitterId | query | string | true | Agent user id if context is AGENT, Customer id if context is CUSTOMER |
| body | body | TicketWithCustomer | true | Ticket to create |
Enumerated Values
| Parameter | Value |
|---|---|
| context | IVR |
| context | SURVEY |
| context | GENERIC |
| context | AGENT |
| context | CUSTOMER |
Responses
Example responses
default Response
{
"article": {
"attachments": [
{
"data": "string",
"filename": "string",
"id": 0,
"mime-type": "string",
"preferences": {
"property1": "string",
"property2": "string"
},
"size": "string"
}
],
"body": "string",
"cc": "string",
"content_type": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"created_by_id": 0,
"from": "string",
"id": 0,
"in_reply_to": "string",
"internal": true,
"message_id": "string",
"message_id_md5": "string",
"origin_by": "string",
"origin_by_id": 0,
"preferences": {
"property1": {},
"property2": {}
},
"references": "string",
"reply_to": "string",
"sender": "Agent",
"sender_id": 0,
"subject": "string",
"ticket_id": 0,
"time_unit": 0,
"to": "string",
"type": "email",
"type_id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"updated_by": "string",
"updated_by_id": 0
},
"article_count": 0,
"article_ids": [
0
],
"articles": [
{
"attachments": [
{
"data": "string",
"filename": "string",
"id": 0,
"mime-type": "string",
"preferences": {
"property1": "string",
"property2": "string"
},
"size": "string"
}
],
"body": "string",
"cc": "string",
"content_type": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"created_by_id": 0,
"from": "string",
"id": 0,
"in_reply_to": "string",
"internal": true,
"message_id": "string",
"message_id_md5": "string",
"origin_by": "string",
"origin_by_id": 0,
"preferences": {
"property1": {},
"property2": {}
},
"references": "string",
"reply_to": "string",
"sender": "Agent",
"sender_id": 0,
"subject": "string",
"ticket_id": 0,
"time_unit": 0,
"to": "string",
"type": "email",
"type_id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"updated_by": "string",
"updated_by_id": 0
}
],
"attachments": [
{
"mimeType": "string",
"name": "string",
"uuid": "string"
}
],
"close_at": "2019-08-24T14:15:22Z",
"close_diff_in_min": 0,
"close_escalation_at": "2019-08-24T14:15:22Z",
"close_in_min": 0,
"create_article_sender": "string",
"create_article_sender_id": 0,
"create_article_type": "string",
"create_article_type_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"created_by_id": 0,
"customer": "string",
"customerContact": {
"type": "USER",
"uid": "string",
"username": "string",
"value": "string"
},
"customer_id": "string",
"escalation_at": "2019-08-24T14:15:22Z",
"first_response_at": "2019-08-24T14:15:22Z",
"first_response_diff_in_min": 0,
"first_response_escalation_at": "2019-08-24T14:15:22Z",
"first_response_in_min": 0,
"group": "string",
"group_id": 0,
"id": 0,
"last_contact_agent_at": "2019-08-24T14:15:22Z",
"last_contact_at": "2019-08-24T14:15:22Z",
"last_contact_customer_at": "2019-08-24T14:15:22Z",
"last_owner_update_at": "2019-08-24T14:15:22Z",
"note": "string",
"number": "string",
"organization": "string",
"organization_id": 0,
"owner": "string",
"ownerContact": {
"type": "USER",
"uid": "string",
"username": "string",
"value": "string"
},
"owner_id": 0,
"pending_time": "2019-08-24T14:15:22Z",
"priority": "1 low",
"priority_id": 0,
"state": "new",
"state_id": 0,
"t_agent_close_date": "2019-08-24T14:15:22Z",
"t_agent_get_date": "2019-08-24T14:15:22Z",
"t_call_link": "string",
"t_create_call_uid": "string",
"t_custom_01": "string",
"t_custom_02": "string",
"t_custom_03": "string",
"t_custom_04": "string",
"t_custom_05": "string",
"t_custom_06": "string",
"t_custom_07": "string",
"t_custom_08": "string",
"t_custom_09": "string",
"t_custom_10": "string",
"t_custom_11": "string",
"t_custom_12": "string",
"t_custom_13": "string",
"t_custom_14": "string",
"t_custom_15": "string",
"t_custom_16": "string",
"t_custom_17": "string",
"t_custom_18": "string",
"t_custom_19": "string",
"t_custom_20": "string",
"t_custom_21": "string",
"t_custom_22": "string",
"t_custom_23": "string",
"t_custom_24": "string",
"t_custom_25": "string",
"t_custom_26": "string",
"t_custom_27": "string",
"t_custom_28": "string",
"t_custom_29": "string",
"t_custom_30": "string",
"t_custom_31": "string",
"t_custom_32": "string",
"t_custom_33": "string",
"t_custom_34": "string",
"t_custom_35": "string",
"t_custom_36": "string",
"t_custom_37": "string",
"t_custom_38": "string",
"t_custom_39": "string",
"t_custom_40": "string",
"t_custom_41": "string",
"t_custom_42": "string",
"t_custom_43": "string",
"t_custom_44": "string",
"t_custom_45": "string",
"t_custom_46": "string",
"t_custom_47": "string",
"t_custom_48": "string",
"t_custom_49": "string",
"t_custom_50": "string",
"t_custom_51": "string",
"t_custom_52": "string",
"t_custom_53": "string",
"t_custom_54": "string",
"t_custom_55": "string",
"t_custom_56": "string",
"t_custom_57": "string",
"t_custom_58": "string",
"t_custom_59": "string",
"t_custom_60": "string",
"t_custom_61": "string",
"t_custom_62": "string",
"t_custom_63": "string",
"t_custom_64": "string",
"t_custom_65": "string",
"t_custom_66": "string",
"t_custom_67": "string",
"t_custom_68": "string",
"t_custom_69": "string",
"t_custom_70": "string",
"t_custom_71": "string",
"t_custom_72": "string",
"t_custom_73": "string",
"t_custom_74": "string",
"t_custom_75": "string",
"t_custom_76": "string",
"t_custom_77": "string",
"t_custom_78": "string",
"t_custom_79": "string",
"t_custom_80": "string",
"t_custom_81": "string",
"t_custom_82": "string",
"t_custom_83": "string",
"t_custom_84": "string",
"t_custom_85": "string",
"t_custom_86": "string",
"t_custom_87": "string",
"t_custom_88": "string",
"t_custom_89": "string",
"t_custom_90": "string",
"t_custom_91": "string",
"t_custom_92": "string",
"t_custom_93": "string",
"t_custom_94": "string",
"t_custom_95": "string",
"t_custom_96": "string",
"t_custom_97": "string",
"t_custom_98": "string",
"t_custom_99": "string",
"t_custom_date_01": "2019-08-24T14:15:22Z",
"t_custom_date_02": "2019-08-24T14:15:22Z",
"t_custom_date_03": "2019-08-24T14:15:22Z",
"t_custom_date_04": "2019-08-24T14:15:22Z",
"t_custom_date_05": "2019-08-24T14:15:22Z",
"t_custom_date_06": "2019-08-24T14:15:22Z",
"t_custom_date_07": "2019-08-24T14:15:22Z",
"t_custom_date_08": "2019-08-24T14:15:22Z",
"t_custom_date_09": "2019-08-24T14:15:22Z",
"t_custom_date_10": "2019-08-24T14:15:22Z",
"t_custom_date_11": "2019-08-24T14:15:22Z",
"t_custom_date_12": "2019-08-24T14:15:22Z",
"t_custom_date_13": "2019-08-24T14:15:22Z",
"t_custom_date_14": "2019-08-24T14:15:22Z",
"t_custom_date_15": "2019-08-24T14:15:22Z",
"t_custom_date_16": "2019-08-24T14:15:22Z",
"t_custom_date_17": "2019-08-24T14:15:22Z",
"t_custom_date_18": "2019-08-24T14:15:22Z",
"t_custom_date_19": "2019-08-24T14:15:22Z",
"t_custom_date_20": "2019-08-24T14:15:22Z",
"t_custom_date_21": "2019-08-24T14:15:22Z",
"t_custom_date_22": "2019-08-24T14:15:22Z",
"t_custom_date_23": "2019-08-24T14:15:22Z",
"t_custom_date_24": "2019-08-24T14:15:22Z",
"t_custom_date_25": "2019-08-24T14:15:22Z",
"t_custom_date_26": "2019-08-24T14:15:22Z",
"t_custom_date_27": "2019-08-24T14:15:22Z",
"t_custom_date_28": "2019-08-24T14:15:22Z",
"t_custom_date_29": "2019-08-24T14:15:22Z",
"t_custom_date_30": "2019-08-24T14:15:22Z",
"t_custom_date_31": "2019-08-24T14:15:22Z",
"t_custom_date_32": "2019-08-24T14:15:22Z",
"t_custom_date_33": "2019-08-24T14:15:22Z",
"t_custom_date_34": "2019-08-24T14:15:22Z",
"t_custom_date_35": "2019-08-24T14:15:22Z",
"t_custom_date_36": "2019-08-24T14:15:22Z",
"t_custom_date_37": "2019-08-24T14:15:22Z",
"t_custom_date_38": "2019-08-24T14:15:22Z",
"t_custom_date_39": "2019-08-24T14:15:22Z",
"t_custom_date_40": "2019-08-24T14:15:22Z",
"t_custom_date_41": "2019-08-24T14:15:22Z",
"t_custom_date_42": "2019-08-24T14:15:22Z",
"t_custom_date_43": "2019-08-24T14:15:22Z",
"t_custom_date_44": "2019-08-24T14:15:22Z",
"t_custom_date_45": "2019-08-24T14:15:22Z",
"t_custom_date_46": "2019-08-24T14:15:22Z",
"t_custom_date_47": "2019-08-24T14:15:22Z",
"t_custom_date_48": "2019-08-24T14:15:22Z",
"t_custom_date_49": "2019-08-24T14:15:22Z",
"t_external_ticketing_add": true,
"t_external_ticketing_link": "string",
"t_forgot_article_count": 0,
"t_forgot_time_unit": 0,
"t_is_child_link": true,
"t_is_forgot_ticket": true,
"t_is_normal_link": true,
"t_is_parent_link": true,
"t_is_view_by_owner": true,
"t_knowledge_base_answer_link": "string",
"t_knowledge_base_answer_uid": "string",
"t_knowledge_base_category_link": "string",
"t_knowledge_base_category_uid": "string",
"t_knowledge_base_id_answer": "string",
"t_knowledge_base_id_category": "string",
"t_last_link_child_update": "string",
"t_last_link_normal_update": "string",
"t_last_link_with": "string",
"t_last_merge_with": "string",
"t_last_owner_view_at": "2019-08-24T14:15:22Z",
"t_queue_type": "string",
"t_reminder_cp_last_time": "2019-08-24T14:15:22Z",
"t_reminder_cp_num": 0,
"t_reminder_tk_last_time": "2019-08-24T14:15:22Z",
"t_reminder_tk_num": 0,
"t_reminder_tk_src": "string",
"t_self_generated_ticket_call_final_state": "string",
"t_self_generated_ticket_type": "string",
"t_social_message_uid": "string",
"t_state_last_update": "2019-08-24T14:15:22Z",
"ticket_time_accounting": [
"string"
],
"ticket_time_accounting_ids": [
0
],
"time_unit": 0,
"title": "string",
"type": "string",
"update_diff_in_min": 0,
"update_escalation_at": "2019-08-24T14:15:22Z",
"update_in_min": 0,
"updated_at": "2019-08-24T14:15:22Z",
"updated_by": "string",
"updated_by_id": 0
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| 404 | Not Found | Error: Object was not found. | GenericObjectWasNotFoundException |
| 406 | Not Acceptable | Error: Invalid argument. | InvalidArgumentException |
| 412 | Precondition Failed | Error: Object required. A required field is missing or empty | GenericObjectRequiredException |
| 510 | Unknown | Error: Invalid license or license not found. | None |
| default | Default | Created ticket | TicketWithCustomer |
Get ticket
Code samples
GET %3CTVOX_HOST%3E/tvox/rest/support/ticket/IVR/string?submitterId=string HTTP/1.1
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/IVR/string?submitterId=string",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request GET \
--url 'https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/IVR/string?submitterId=string' \
--header 'Accept: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID'
HttpResponse<String> response = Unirest.get("https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/IVR/string?submitterId=string")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.asString();
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/IVR/string?submitterId=string"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("GET", "https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/IVR/string?submitterId=string");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "GET",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/support/ticket/IVR/string?submitterId=string",
"headers": {
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
import http.client
conn = http.client.HTTPSConnection("")
headers = {
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("GET", "%3CTVOX_HOST%3E/tvox/rest/support/ticket/IVR/string?submitterId=string", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/IVR/string?submitterId=string")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
response = http.request(request)
puts response.read_body
GET /rest/support/ticket/{context}/{ticketId}
Get a ticket by choosing the appropriate context and providing ticket id
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| context | path | string | true | Ticket context |
| ticketId | path | string | true | Ticket id |
| submitterId | query | string | true | Agent user id if context is AGENT, Customer id if context is CUSTOMER |
Enumerated Values
| Parameter | Value |
|---|---|
| context | IVR |
| context | SURVEY |
| context | GENERIC |
| context | AGENT |
| context | CUSTOMER |
Responses
Example responses
default Response
{
"article": {
"attachments": [
{
"data": "string",
"filename": "string",
"id": 0,
"mime-type": "string",
"preferences": {
"property1": "string",
"property2": "string"
},
"size": "string"
}
],
"body": "string",
"cc": "string",
"content_type": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"created_by_id": 0,
"from": "string",
"id": 0,
"in_reply_to": "string",
"internal": true,
"message_id": "string",
"message_id_md5": "string",
"origin_by": "string",
"origin_by_id": 0,
"preferences": {
"property1": {},
"property2": {}
},
"references": "string",
"reply_to": "string",
"sender": "Agent",
"sender_id": 0,
"subject": "string",
"ticket_id": 0,
"time_unit": 0,
"to": "string",
"type": "email",
"type_id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"updated_by": "string",
"updated_by_id": 0
},
"article_count": 0,
"article_ids": [
0
],
"articles": [
{
"attachments": [
{
"data": "string",
"filename": "string",
"id": 0,
"mime-type": "string",
"preferences": {
"property1": "string",
"property2": "string"
},
"size": "string"
}
],
"body": "string",
"cc": "string",
"content_type": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"created_by_id": 0,
"from": "string",
"id": 0,
"in_reply_to": "string",
"internal": true,
"message_id": "string",
"message_id_md5": "string",
"origin_by": "string",
"origin_by_id": 0,
"preferences": {
"property1": {},
"property2": {}
},
"references": "string",
"reply_to": "string",
"sender": "Agent",
"sender_id": 0,
"subject": "string",
"ticket_id": 0,
"time_unit": 0,
"to": "string",
"type": "email",
"type_id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"updated_by": "string",
"updated_by_id": 0
}
],
"attachments": [
{
"mimeType": "string",
"name": "string",
"uuid": "string"
}
],
"close_at": "2019-08-24T14:15:22Z",
"close_diff_in_min": 0,
"close_escalation_at": "2019-08-24T14:15:22Z",
"close_in_min": 0,
"create_article_sender": "string",
"create_article_sender_id": 0,
"create_article_type": "string",
"create_article_type_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"created_by_id": 0,
"customer": "string",
"customerContact": {
"type": "USER",
"uid": "string",
"username": "string",
"value": "string"
},
"customer_id": "string",
"escalation_at": "2019-08-24T14:15:22Z",
"first_response_at": "2019-08-24T14:15:22Z",
"first_response_diff_in_min": 0,
"first_response_escalation_at": "2019-08-24T14:15:22Z",
"first_response_in_min": 0,
"group": "string",
"group_id": 0,
"id": 0,
"last_contact_agent_at": "2019-08-24T14:15:22Z",
"last_contact_at": "2019-08-24T14:15:22Z",
"last_contact_customer_at": "2019-08-24T14:15:22Z",
"last_owner_update_at": "2019-08-24T14:15:22Z",
"note": "string",
"number": "string",
"organization": "string",
"organization_id": 0,
"owner": "string",
"ownerContact": {
"type": "USER",
"uid": "string",
"username": "string",
"value": "string"
},
"owner_id": 0,
"pending_time": "2019-08-24T14:15:22Z",
"priority": "1 low",
"priority_id": 0,
"state": "new",
"state_id": 0,
"t_agent_close_date": "2019-08-24T14:15:22Z",
"t_agent_get_date": "2019-08-24T14:15:22Z",
"t_call_link": "string",
"t_create_call_uid": "string",
"t_custom_01": "string",
"t_custom_02": "string",
"t_custom_03": "string",
"t_custom_04": "string",
"t_custom_05": "string",
"t_custom_06": "string",
"t_custom_07": "string",
"t_custom_08": "string",
"t_custom_09": "string",
"t_custom_10": "string",
"t_custom_11": "string",
"t_custom_12": "string",
"t_custom_13": "string",
"t_custom_14": "string",
"t_custom_15": "string",
"t_custom_16": "string",
"t_custom_17": "string",
"t_custom_18": "string",
"t_custom_19": "string",
"t_custom_20": "string",
"t_custom_21": "string",
"t_custom_22": "string",
"t_custom_23": "string",
"t_custom_24": "string",
"t_custom_25": "string",
"t_custom_26": "string",
"t_custom_27": "string",
"t_custom_28": "string",
"t_custom_29": "string",
"t_custom_30": "string",
"t_custom_31": "string",
"t_custom_32": "string",
"t_custom_33": "string",
"t_custom_34": "string",
"t_custom_35": "string",
"t_custom_36": "string",
"t_custom_37": "string",
"t_custom_38": "string",
"t_custom_39": "string",
"t_custom_40": "string",
"t_custom_41": "string",
"t_custom_42": "string",
"t_custom_43": "string",
"t_custom_44": "string",
"t_custom_45": "string",
"t_custom_46": "string",
"t_custom_47": "string",
"t_custom_48": "string",
"t_custom_49": "string",
"t_custom_50": "string",
"t_custom_51": "string",
"t_custom_52": "string",
"t_custom_53": "string",
"t_custom_54": "string",
"t_custom_55": "string",
"t_custom_56": "string",
"t_custom_57": "string",
"t_custom_58": "string",
"t_custom_59": "string",
"t_custom_60": "string",
"t_custom_61": "string",
"t_custom_62": "string",
"t_custom_63": "string",
"t_custom_64": "string",
"t_custom_65": "string",
"t_custom_66": "string",
"t_custom_67": "string",
"t_custom_68": "string",
"t_custom_69": "string",
"t_custom_70": "string",
"t_custom_71": "string",
"t_custom_72": "string",
"t_custom_73": "string",
"t_custom_74": "string",
"t_custom_75": "string",
"t_custom_76": "string",
"t_custom_77": "string",
"t_custom_78": "string",
"t_custom_79": "string",
"t_custom_80": "string",
"t_custom_81": "string",
"t_custom_82": "string",
"t_custom_83": "string",
"t_custom_84": "string",
"t_custom_85": "string",
"t_custom_86": "string",
"t_custom_87": "string",
"t_custom_88": "string",
"t_custom_89": "string",
"t_custom_90": "string",
"t_custom_91": "string",
"t_custom_92": "string",
"t_custom_93": "string",
"t_custom_94": "string",
"t_custom_95": "string",
"t_custom_96": "string",
"t_custom_97": "string",
"t_custom_98": "string",
"t_custom_99": "string",
"t_custom_date_01": "2019-08-24T14:15:22Z",
"t_custom_date_02": "2019-08-24T14:15:22Z",
"t_custom_date_03": "2019-08-24T14:15:22Z",
"t_custom_date_04": "2019-08-24T14:15:22Z",
"t_custom_date_05": "2019-08-24T14:15:22Z",
"t_custom_date_06": "2019-08-24T14:15:22Z",
"t_custom_date_07": "2019-08-24T14:15:22Z",
"t_custom_date_08": "2019-08-24T14:15:22Z",
"t_custom_date_09": "2019-08-24T14:15:22Z",
"t_custom_date_10": "2019-08-24T14:15:22Z",
"t_custom_date_11": "2019-08-24T14:15:22Z",
"t_custom_date_12": "2019-08-24T14:15:22Z",
"t_custom_date_13": "2019-08-24T14:15:22Z",
"t_custom_date_14": "2019-08-24T14:15:22Z",
"t_custom_date_15": "2019-08-24T14:15:22Z",
"t_custom_date_16": "2019-08-24T14:15:22Z",
"t_custom_date_17": "2019-08-24T14:15:22Z",
"t_custom_date_18": "2019-08-24T14:15:22Z",
"t_custom_date_19": "2019-08-24T14:15:22Z",
"t_custom_date_20": "2019-08-24T14:15:22Z",
"t_custom_date_21": "2019-08-24T14:15:22Z",
"t_custom_date_22": "2019-08-24T14:15:22Z",
"t_custom_date_23": "2019-08-24T14:15:22Z",
"t_custom_date_24": "2019-08-24T14:15:22Z",
"t_custom_date_25": "2019-08-24T14:15:22Z",
"t_custom_date_26": "2019-08-24T14:15:22Z",
"t_custom_date_27": "2019-08-24T14:15:22Z",
"t_custom_date_28": "2019-08-24T14:15:22Z",
"t_custom_date_29": "2019-08-24T14:15:22Z",
"t_custom_date_30": "2019-08-24T14:15:22Z",
"t_custom_date_31": "2019-08-24T14:15:22Z",
"t_custom_date_32": "2019-08-24T14:15:22Z",
"t_custom_date_33": "2019-08-24T14:15:22Z",
"t_custom_date_34": "2019-08-24T14:15:22Z",
"t_custom_date_35": "2019-08-24T14:15:22Z",
"t_custom_date_36": "2019-08-24T14:15:22Z",
"t_custom_date_37": "2019-08-24T14:15:22Z",
"t_custom_date_38": "2019-08-24T14:15:22Z",
"t_custom_date_39": "2019-08-24T14:15:22Z",
"t_custom_date_40": "2019-08-24T14:15:22Z",
"t_custom_date_41": "2019-08-24T14:15:22Z",
"t_custom_date_42": "2019-08-24T14:15:22Z",
"t_custom_date_43": "2019-08-24T14:15:22Z",
"t_custom_date_44": "2019-08-24T14:15:22Z",
"t_custom_date_45": "2019-08-24T14:15:22Z",
"t_custom_date_46": "2019-08-24T14:15:22Z",
"t_custom_date_47": "2019-08-24T14:15:22Z",
"t_custom_date_48": "2019-08-24T14:15:22Z",
"t_custom_date_49": "2019-08-24T14:15:22Z",
"t_external_ticketing_add": true,
"t_external_ticketing_link": "string",
"t_forgot_article_count": 0,
"t_forgot_time_unit": 0,
"t_is_child_link": true,
"t_is_forgot_ticket": true,
"t_is_normal_link": true,
"t_is_parent_link": true,
"t_is_view_by_owner": true,
"t_knowledge_base_answer_link": "string",
"t_knowledge_base_answer_uid": "string",
"t_knowledge_base_category_link": "string",
"t_knowledge_base_category_uid": "string",
"t_knowledge_base_id_answer": "string",
"t_knowledge_base_id_category": "string",
"t_last_link_child_update": "string",
"t_last_link_normal_update": "string",
"t_last_link_with": "string",
"t_last_merge_with": "string",
"t_last_owner_view_at": "2019-08-24T14:15:22Z",
"t_queue_type": "string",
"t_reminder_cp_last_time": "2019-08-24T14:15:22Z",
"t_reminder_cp_num": 0,
"t_reminder_tk_last_time": "2019-08-24T14:15:22Z",
"t_reminder_tk_num": 0,
"t_reminder_tk_src": "string",
"t_self_generated_ticket_call_final_state": "string",
"t_self_generated_ticket_type": "string",
"t_social_message_uid": "string",
"t_state_last_update": "2019-08-24T14:15:22Z",
"ticket_time_accounting": [
"string"
],
"ticket_time_accounting_ids": [
0
],
"time_unit": 0,
"title": "string",
"type": "string",
"update_diff_in_min": 0,
"update_escalation_at": "2019-08-24T14:15:22Z",
"update_in_min": 0,
"updated_at": "2019-08-24T14:15:22Z",
"updated_by": "string",
"updated_by_id": 0
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| 406 | Not Acceptable | Error: Invalid argument. | InvalidArgumentException |
| 412 | Precondition Failed | Error: Object required. A required field is missing or empty | GenericObjectRequiredException |
| default | Default | Get ticket | TicketWithCustomer |
Add ticket note
Code samples
POST %3CTVOX_HOST%3E/tvox/rest/support/ticket/IVR/string/add-article-note?submitterId=string HTTP/1.1
Content-Type: application/json
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
Content-Length: 103
{"attachments":[{"mimeType":"string","name":"string","uuid":"string"}],"body":"string","internal":true}
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/IVR/string/add-article-note?submitterId=string",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "{\"attachments\":[{\"mimeType\":\"string\",\"name\":\"string\",\"uuid\":\"string\"}],\"body\":\"string\",\"internal\":true}",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Content-Type: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request POST \
--url 'https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/IVR/string/add-article-note?submitterId=string' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID' \
--data '{"attachments":[{"mimeType":"string","name":"string","uuid":"string"}],"body":"string","internal":true}'
HttpResponse<String> response = Unirest.post("https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/IVR/string/add-article-note?submitterId=string")
.header("Content-Type", "application/json")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.body("{\"attachments\":[{\"mimeType\":\"string\",\"name\":\"string\",\"uuid\":\"string\"}],\"body\":\"string\",\"internal\":true}")
.asString();
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/IVR/string/add-article-note?submitterId=string"
payload := strings.NewReader("{\"attachments\":[{\"mimeType\":\"string\",\"name\":\"string\",\"uuid\":\"string\"}],\"body\":\"string\",\"internal\":true}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = JSON.stringify({
"attachments": [
{
"mimeType": "string",
"name": "string",
"uuid": "string"
}
],
"body": "string",
"internal": true
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("POST", "https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/IVR/string/add-article-note?submitterId=string");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "POST",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/support/ticket/IVR/string/add-article-note?submitterId=string",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
attachments: [{mimeType: 'string', name: 'string', uuid: 'string'}],
body: 'string',
internal: true
}));
req.end();
import http.client
conn = http.client.HTTPSConnection("")
payload = "{\"attachments\":[{\"mimeType\":\"string\",\"name\":\"string\",\"uuid\":\"string\"}],\"body\":\"string\",\"internal\":true}"
headers = {
'Content-Type': "application/json",
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("POST", "%3CTVOX_HOST%3E/tvox/rest/support/ticket/IVR/string/add-article-note?submitterId=string", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/IVR/string/add-article-note?submitterId=string")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
request.body = "{\"attachments\":[{\"mimeType\":\"string\",\"name\":\"string\",\"uuid\":\"string\"}],\"body\":\"string\",\"internal\":true}"
response = http.request(request)
puts response.read_body
POST /rest/support/ticket/{context}/{ticketId}/add-article-note
Add notes on a ticket by choosing the appropriate context and providing ticket id
Parameters
Body parameter
{
"attachments": [
{
"mimeType": "string",
"name": "string",
"uuid": "string"
}
],
"body": "string",
"internal": true
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| context | path | string | true | Ticket context |
| ticketId | path | string | true | Ticket id |
| submitterId | query | string | true | Agent user id if context is AGENT, Customer id if context is CUSTOMER |
| body | body | TicketAddArticleNoteRequest | true | Ticket article |
Enumerated Values
| Parameter | Value |
|---|---|
| context | IVR |
| context | SURVEY |
| context | GENERIC |
| context | AGENT |
| context | CUSTOMER |
Responses
Example responses
default Response
{
"attachments": [
{
"data": "string",
"filename": "string",
"id": 0,
"mime-type": "string",
"preferences": {
"property1": "string",
"property2": "string"
},
"size": "string"
}
],
"body": "string",
"cc": "string",
"content_type": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"created_by_id": 0,
"from": "string",
"id": 0,
"in_reply_to": "string",
"internal": true,
"message_id": "string",
"message_id_md5": "string",
"origin_by": "string",
"origin_by_id": 0,
"preferences": {
"property1": {},
"property2": {}
},
"references": "string",
"reply_to": "string",
"sender": "Agent",
"sender_id": 0,
"subject": "string",
"ticket_id": 0,
"time_unit": 0,
"to": "string",
"type": "email",
"type_id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"updated_by": "string",
"updated_by_id": 0
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| 406 | Not Acceptable | Error: Invalid argument. | InvalidArgumentException |
| 412 | Precondition Failed | Error: Object required. A required field is missing or empty | GenericObjectRequiredException |
| 510 | Unknown | Error: Invalid license or license not found. | None |
| default | Default | Add ticket note | TicketArticle |
Get ticket articles
Code samples
GET %3CTVOX_HOST%3E/tvox/rest/support/ticket/IVR/string/articles?submitterId=string HTTP/1.1
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/IVR/string/articles?submitterId=string",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request GET \
--url 'https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/IVR/string/articles?submitterId=string' \
--header 'Accept: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID'
HttpResponse<String> response = Unirest.get("https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/IVR/string/articles?submitterId=string")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.asString();
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/IVR/string/articles?submitterId=string"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("GET", "https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/IVR/string/articles?submitterId=string");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "GET",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/support/ticket/IVR/string/articles?submitterId=string",
"headers": {
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
import http.client
conn = http.client.HTTPSConnection("")
headers = {
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("GET", "%3CTVOX_HOST%3E/tvox/rest/support/ticket/IVR/string/articles?submitterId=string", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/IVR/string/articles?submitterId=string")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
response = http.request(request)
puts response.read_body
GET /rest/support/ticket/{context}/{ticketId}/articles
Get ticket articles by choosing the appropriate context and providing ticket id
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| context | path | string | true | Ticket context |
| ticketId | path | string | true | Ticket id |
| submitterId | query | string | true | Agent user id if context is AGENT, Customer id if context is CUSTOMER |
Enumerated Values
| Parameter | Value |
|---|---|
| context | IVR |
| context | SURVEY |
| context | GENERIC |
| context | AGENT |
| context | CUSTOMER |
Responses
Example responses
default Response
{
"attachments": [
{
"data": "string",
"filename": "string",
"id": 0,
"mime-type": "string",
"preferences": {
"property1": "string",
"property2": "string"
},
"size": "string"
}
],
"body": "string",
"cc": "string",
"content_type": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"created_by_id": 0,
"from": "string",
"id": 0,
"in_reply_to": "string",
"internal": true,
"message_id": "string",
"message_id_md5": "string",
"origin_by": "string",
"origin_by_id": 0,
"preferences": {
"property1": {},
"property2": {}
},
"references": "string",
"reply_to": "string",
"sender": "Agent",
"sender_id": 0,
"subject": "string",
"ticket_id": 0,
"time_unit": 0,
"to": "string",
"type": "email",
"type_id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"updated_by": "string",
"updated_by_id": 0
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| 406 | Not Acceptable | Error: Invalid argument. | InvalidArgumentException |
| 412 | Precondition Failed | Error: Object required. A required field is missing or empty | GenericObjectRequiredException |
| default | Default | Get ticket articles | [TicketArticle] |
Update service on ticket
Code samples
PUT %3CTVOX_HOST%3E/tvox/rest/support/ticket/IVR/0/update-service?serviceCode=string HTTP/1.1
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/IVR/0/update-service?serviceCode=string",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request PUT \
--url 'https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/IVR/0/update-service?serviceCode=string' \
--header 'Accept: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID'
HttpResponse<String> response = Unirest.put("https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/IVR/0/update-service?serviceCode=string")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.asString();
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/IVR/0/update-service?serviceCode=string"
req, _ := http.NewRequest("PUT", url, nil)
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("PUT", "https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/IVR/0/update-service?serviceCode=string");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "PUT",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/support/ticket/IVR/0/update-service?serviceCode=string",
"headers": {
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
import http.client
conn = http.client.HTTPSConnection("")
headers = {
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("PUT", "%3CTVOX_HOST%3E/tvox/rest/support/ticket/IVR/0/update-service?serviceCode=string", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/support/ticket/IVR/0/update-service?serviceCode=string")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Put.new(url)
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
response = http.request(request)
puts response.read_body
PUT /rest/support/ticket/{context}/{ticketId}/update-service
Update service on ticket
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| context | path | string | true | Ticket context |
| ticketId | path | integer(int32) | true | Ticket id |
| submitterId | query | string | false | Agent user id if context is AGENT |
| serviceCode | query | string | true | Service code to update ticket with |
Enumerated Values
| Parameter | Value |
|---|---|
| context | IVR |
| context | SURVEY |
| context | GENERIC |
| context | AGENT |
| context | CUSTOMER |
Responses
Example responses
default Response
true
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| 404 | Not Found | Error: Object was not found. | GenericObjectWasNotFoundException |
| 406 | Not Acceptable | Error: Invalid argument. | InvalidArgumentException |
| 412 | Precondition Failed | Error: Object required. A required field is missing or empty | GenericObjectRequiredException |
| 510 | Unknown | Error: Invalid license or license not found. | None |
| default | Default | Updated service on ticket | boolean |
TVox Users Management
Manage users on TVox
Acquire exten by pin
Code samples
GET %3CTVOX_HOST%3E/tvox/rest/tvox/users/acquire-exten-by-pin/string/string HTTP/1.1
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/tvox/users/acquire-exten-by-pin/string/string",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request GET \
--url https:///%3CTVOX_HOST%3E/tvox/rest/tvox/users/acquire-exten-by-pin/string/string \
--header 'Accept: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID'
HttpResponse<String> response = Unirest.get("https:///%3CTVOX_HOST%3E/tvox/rest/tvox/users/acquire-exten-by-pin/string/string")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.asString();
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/tvox/users/acquire-exten-by-pin/string/string"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("GET", "https:///%3CTVOX_HOST%3E/tvox/rest/tvox/users/acquire-exten-by-pin/string/string");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "GET",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/tvox/users/acquire-exten-by-pin/string/string",
"headers": {
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
import http.client
conn = http.client.HTTPSConnection("")
headers = {
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("GET", "%3CTVOX_HOST%3E/tvox/rest/tvox/users/acquire-exten-by-pin/string/string", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/tvox/users/acquire-exten-by-pin/string/string")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
response = http.request(request)
puts response.read_body
GET /rest/tvox/users/acquire-exten-by-pin/{pin}/{exten}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| pin | path | string | true | Pin of the user |
| exten | path | string | true | Exten to acquire |
Responses
Example responses
default Response
{
"callBackNumbers": [
"string"
],
"callFowardSettings": {
"property1": {
"actionInCalendar": {
"actionToDo": "DIAL"
},
"actionOutCalendar": {
"actionToDo": "DIAL"
},
"calendarEnable": true,
"context": "ENABLE_FROM_PHONE",
"extendedCallFowardFuncInCalendar": {
"alternativeAccessCode": "string",
"alternativeNumber": "string",
"alternativeNumberRingTime": 0,
"confirmRequired": true,
"notifyCallFile": {
"content": "string",
"duration": 0,
"erasable": true,
"file": "string",
"musicOnHold": true,
"name": "string",
"producedByTTS": true,
"ttsLanguage": "string",
"ttsProfile": "string",
"ttsType": "string",
"ttsVoice": "string"
},
"notifyCallLost": "EMAIL",
"twinMode": true
},
"extendedCallFowardFuncOutCalendar": {
"alternativeAccessCode": "string",
"alternativeNumber": "string",
"alternativeNumberRingTime": 0,
"confirmRequired": true,
"notifyCallFile": {
"content": "string",
"duration": 0,
"erasable": true,
"file": "string",
"musicOnHold": true,
"name": "string",
"producedByTTS": true,
"ttsLanguage": "string",
"ttsProfile": "string",
"ttsType": "string",
"ttsVoice": "string"
},
"notifyCallLost": "EMAIL",
"twinMode": true
},
"notifyCallLost": "EMAIL",
"ringTimeInCalendar": 0,
"ringTimeOutCalendar": 0,
"status": "ENABLE_ALL"
},
"property2": {
"actionInCalendar": {
"actionToDo": "DIAL"
},
"actionOutCalendar": {
"actionToDo": "DIAL"
},
"calendarEnable": true,
"context": "ENABLE_FROM_PHONE",
"extendedCallFowardFuncInCalendar": {
"alternativeAccessCode": "string",
"alternativeNumber": "string",
"alternativeNumberRingTime": 0,
"confirmRequired": true,
"notifyCallFile": {
"content": "string",
"duration": 0,
"erasable": true,
"file": "string",
"musicOnHold": true,
"name": "string",
"producedByTTS": true,
"ttsLanguage": "string",
"ttsProfile": "string",
"ttsType": "string",
"ttsVoice": "string"
},
"notifyCallLost": "EMAIL",
"twinMode": true
},
"extendedCallFowardFuncOutCalendar": {
"alternativeAccessCode": "string",
"alternativeNumber": "string",
"alternativeNumberRingTime": 0,
"confirmRequired": true,
"notifyCallFile": {
"content": "string",
"duration": 0,
"erasable": true,
"file": "string",
"musicOnHold": true,
"name": "string",
"producedByTTS": true,
"ttsLanguage": "string",
"ttsProfile": "string",
"ttsType": "string",
"ttsVoice": "string"
},
"notifyCallLost": "EMAIL",
"twinMode": true
},
"notifyCallLost": "EMAIL",
"ringTimeInCalendar": 0,
"ringTimeOutCalendar": 0,
"status": "ENABLE_ALL"
}
},
"conference": {
"adminpin": "string",
"chooseLanguageEnable": true,
"closeByAdminHangupEnabled": true,
"countPresentMembersEnabled": true,
"enable": true,
"greetingMsg": {
"content": "string",
"duration": 0,
"erasable": true,
"file": "string",
"musicOnHold": true,
"name": "string",
"producedByTTS": true,
"ttsLanguage": "string",
"ttsProfile": "string",
"ttsType": "string",
"ttsVoice": "string"
},
"language": "IT",
"musicOnHoldEnabled": true,
"name": "string",
"notifyAccessEnabled": true,
"notifyTone": true,
"number": "string",
"ownerUser": "string",
"publicNumber": true,
"userAnnounceEnabled": true,
"userpin": "string",
"volMenuEnabled": true,
"waitAdmin": true
},
"directory": {
"customCli": "string",
"customCliType": "CUST",
"customFields": {
"property1": "string",
"property2": "string"
},
"email": "string",
"fax": "string",
"homePhone": "string",
"mobilePhone": "string",
"otherPhone": "string"
},
"faxes": [
{
"administrator": true,
"fax": {
"identifier": 0,
"name": "string"
},
"receiving": "MAIL",
"receivingEnabled": true,
"sending": "MAIL",
"sendingEnabled": true
}
],
"name": "string",
"number": "string",
"pinForPhoneServices": "string",
"profiles": [
{
"abilitazioneProfile": {
"descrizione": "string",
"id": 0
},
"filtroProfile": {
"descrizione": "string",
"id": 0
},
"id": 0,
"label": "string",
"maxCallInbound": 0,
"recNoticeEnabled": true,
"registration": "DISABLED",
"tvoxStatus": "READY",
"type": "UC",
"username": "string"
}
],
"publicUsername": "string",
"sessionId": "string",
"status": "UNKNOWN",
"supervisor": true,
"surname": "string",
"ucConf": {
"chatEnabled": true,
"externalLookupEnabled": true,
"meetingCreatePermission": {
"defaultValue": true,
"enableDefault": true,
"value": true
},
"outlookPluginEnabled": true,
"persistentInteractionsEnabled": true,
"personalAddressbookEnabled": {
"defaultValue": true,
"enableDefault": true,
"value": true
},
"presenceActive": true,
"roomsVisibilityEnabled": true,
"sendingSMSEnabled": true,
"visible": true
},
"username": "string",
"voicemail": {
"language": "IT",
"maxmsg": 0,
"password": "string",
"toAttachFile": true,
"toDeleteFile": true,
"toSendEmail": true,
"uniqueid": 0
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 412 | Precondition Failed | Error: Object required. A required field is missing or empty | GenericObjectRequiredException |
| 502 | Bad Gateway | Error: Login user or exten add to user failed. | None |
| default | Default | User that acquire exten | UserDetail |
Search users with automated attendant feature enabled
Code samples
POST %3CTVOX_HOST%3E/tvox/rest/tvox/users/automated-attendant/search HTTP/1.1
Content-Type: application/json
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
Content-Length: 106
{"limit":{"pageNumber":0,"pageSize":0},"sort":{"orderField":"USERNAME","orderType":"ASC"},"term":"string"}
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/tvox/users/automated-attendant/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "{\"limit\":{\"pageNumber\":0,\"pageSize\":0},\"sort\":{\"orderField\":\"USERNAME\",\"orderType\":\"ASC\"},\"term\":\"string\"}",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Content-Type: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request POST \
--url https:///%3CTVOX_HOST%3E/tvox/rest/tvox/users/automated-attendant/search \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID' \
--data '{"limit":{"pageNumber":0,"pageSize":0},"sort":{"orderField":"USERNAME","orderType":"ASC"},"term":"string"}'
HttpResponse<String> response = Unirest.post("https:///%3CTVOX_HOST%3E/tvox/rest/tvox/users/automated-attendant/search")
.header("Content-Type", "application/json")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.body("{\"limit\":{\"pageNumber\":0,\"pageSize\":0},\"sort\":{\"orderField\":\"USERNAME\",\"orderType\":\"ASC\"},\"term\":\"string\"}")
.asString();
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/tvox/users/automated-attendant/search"
payload := strings.NewReader("{\"limit\":{\"pageNumber\":0,\"pageSize\":0},\"sort\":{\"orderField\":\"USERNAME\",\"orderType\":\"ASC\"},\"term\":\"string\"}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = JSON.stringify({
"limit": {
"pageNumber": 0,
"pageSize": 0
},
"sort": {
"orderField": "USERNAME",
"orderType": "ASC"
},
"term": "string"
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("POST", "https:///%3CTVOX_HOST%3E/tvox/rest/tvox/users/automated-attendant/search");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "POST",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/tvox/users/automated-attendant/search",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
limit: {pageNumber: 0, pageSize: 0},
sort: {orderField: 'USERNAME', orderType: 'ASC'},
term: 'string'
}));
req.end();
import http.client
conn = http.client.HTTPSConnection("")
payload = "{\"limit\":{\"pageNumber\":0,\"pageSize\":0},\"sort\":{\"orderField\":\"USERNAME\",\"orderType\":\"ASC\"},\"term\":\"string\"}"
headers = {
'Content-Type': "application/json",
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("POST", "%3CTVOX_HOST%3E/tvox/rest/tvox/users/automated-attendant/search", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/tvox/users/automated-attendant/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
request.body = "{\"limit\":{\"pageNumber\":0,\"pageSize\":0},\"sort\":{\"orderField\":\"USERNAME\",\"orderType\":\"ASC\"},\"term\":\"string\"}"
response = http.request(request)
puts response.read_body
POST /rest/tvox/users/automated-attendant/search
Parameters
Body parameter
{
"limit": {
"pageNumber": 0,
"pageSize": 0
},
"sort": {
"orderField": "USERNAME",
"orderType": "ASC"
},
"term": "string"
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | SearchUserAutomatedAttendantRequest | true | Search user with automated attendant feature enabled request |
Responses
Example responses
default Response
{
"result": [
{
"automatedAttendantConsoleServiceExten": "string",
"exten": "string",
"name": "string",
"publicUsername": "string",
"surname": "string",
"userAvailable": true,
"username": "string"
}
],
"tot": 0
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| default | Default | TVox users with automated attendant feature enabled searched | SearchResultUserAutomatedAttendant |
Force logout of agent
Code samples
GET %3CTVOX_HOST%3E/tvox/rest/tvox/users/logout/string HTTP/1.1
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/tvox/users/logout/string",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request GET \
--url https:///%3CTVOX_HOST%3E/tvox/rest/tvox/users/logout/string \
--header 'Accept: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID'
HttpResponse<String> response = Unirest.get("https:///%3CTVOX_HOST%3E/tvox/rest/tvox/users/logout/string")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.asString();
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/tvox/users/logout/string"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("GET", "https:///%3CTVOX_HOST%3E/tvox/rest/tvox/users/logout/string");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "GET",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/tvox/users/logout/string",
"headers": {
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
import http.client
conn = http.client.HTTPSConnection("")
headers = {
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("GET", "%3CTVOX_HOST%3E/tvox/rest/tvox/users/logout/string", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/tvox/users/logout/string")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
response = http.request(request)
puts response.read_body
GET /rest/tvox/users/logout/{id}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | Agent user id |
Responses
Example responses
default Response
true
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 404 | Not Found | Error: Object was not found. | GenericObjectWasNotFoundException |
| 502 | Bad Gateway | Error: Logout user failed. | LogoutUserException |
| 570 | Unknown | Error: Logout is not allowed for user cause logged in one or more calendar schedule. | LogoutNotAllowedCauseLoggedInCalendarSchedule |
| default | Default | Agent logged out | boolean |
Get user id by pin
Code samples
GET %3CTVOX_HOST%3E/tvox/rest/tvox/users/username-by-pin/string HTTP/1.1
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/tvox/users/username-by-pin/string",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request GET \
--url https:///%3CTVOX_HOST%3E/tvox/rest/tvox/users/username-by-pin/string \
--header 'Accept: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID'
HttpResponse<String> response = Unirest.get("https:///%3CTVOX_HOST%3E/tvox/rest/tvox/users/username-by-pin/string")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.asString();
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/tvox/users/username-by-pin/string"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("GET", "https:///%3CTVOX_HOST%3E/tvox/rest/tvox/users/username-by-pin/string");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "GET",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/tvox/users/username-by-pin/string",
"headers": {
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
import http.client
conn = http.client.HTTPSConnection("")
headers = {
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("GET", "%3CTVOX_HOST%3E/tvox/rest/tvox/users/username-by-pin/string", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/tvox/users/username-by-pin/string")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
response = http.request(request)
puts response.read_body
GET /rest/tvox/users/username-by-pin/{pin}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| pin | path | string | true | Pin of the user |
Responses
Example responses
default Response
"string"
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 404 | Not Found | Error: Object was not found. | GenericObjectWasNotFoundException |
| 412 | Precondition Failed | Error: Object required. A required field is missing or empty | GenericObjectRequiredException |
| default | Default | User id of the user associated with the given pin | string |
Get user
Code samples
GET %3CTVOX_HOST%3E/tvox/rest/tvox/users/string HTTP/1.1
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/tvox/users/string",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request GET \
--url https:///%3CTVOX_HOST%3E/tvox/rest/tvox/users/string \
--header 'Accept: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID'
HttpResponse<String> response = Unirest.get("https:///%3CTVOX_HOST%3E/tvox/rest/tvox/users/string")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.asString();
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/tvox/users/string"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("GET", "https:///%3CTVOX_HOST%3E/tvox/rest/tvox/users/string");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "GET",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/tvox/users/string",
"headers": {
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
import http.client
conn = http.client.HTTPSConnection("")
headers = {
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("GET", "%3CTVOX_HOST%3E/tvox/rest/tvox/users/string", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/tvox/users/string")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
response = http.request(request)
puts response.read_body
GET /rest/tvox/users/{id}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | User id |
Responses
Example responses
default Response
{
"abilitazioneForAuthCode": {
"descrizione": "string",
"id": 0
},
"accessList": {
"actionDescription": "string",
"actionType": "HANGUP",
"actionValue": "string",
"id": 0,
"name": "string",
"type": "BLACK",
"values": {
"property1": "string",
"property2": "string"
}
},
"automatedAttendantConsoleEnable": true,
"automatedAttendantConsoleService": "string",
"callFowardSettings": {
"property1": {
"actionInCalendar": {
"actionToDo": "DIAL"
},
"actionOutCalendar": {
"actionToDo": "DIAL"
},
"calendarEnable": true,
"context": "ENABLE_FROM_PHONE",
"extendedCallFowardFuncInCalendar": {
"alternativeAccessCode": "string",
"alternativeNumber": "string",
"alternativeNumberRingTime": 0,
"confirmRequired": true,
"notifyCallFile": {
"content": "string",
"duration": 0,
"erasable": true,
"file": "string",
"musicOnHold": true,
"name": "string",
"producedByTTS": true,
"ttsLanguage": "string",
"ttsProfile": "string",
"ttsType": "string",
"ttsVoice": "string"
},
"notifyCallLost": "EMAIL",
"twinMode": true
},
"extendedCallFowardFuncOutCalendar": {
"alternativeAccessCode": "string",
"alternativeNumber": "string",
"alternativeNumberRingTime": 0,
"confirmRequired": true,
"notifyCallFile": {
"content": "string",
"duration": 0,
"erasable": true,
"file": "string",
"musicOnHold": true,
"name": "string",
"producedByTTS": true,
"ttsLanguage": "string",
"ttsProfile": "string",
"ttsType": "string",
"ttsVoice": "string"
},
"notifyCallLost": "EMAIL",
"twinMode": true
},
"notifyCallLost": "EMAIL",
"ringTimeInCalendar": 0,
"ringTimeOutCalendar": 0,
"status": "ENABLE_ALL"
},
"property2": {
"actionInCalendar": {
"actionToDo": "DIAL"
},
"actionOutCalendar": {
"actionToDo": "DIAL"
},
"calendarEnable": true,
"context": "ENABLE_FROM_PHONE",
"extendedCallFowardFuncInCalendar": {
"alternativeAccessCode": "string",
"alternativeNumber": "string",
"alternativeNumberRingTime": 0,
"confirmRequired": true,
"notifyCallFile": {
"content": "string",
"duration": 0,
"erasable": true,
"file": "string",
"musicOnHold": true,
"name": "string",
"producedByTTS": true,
"ttsLanguage": "string",
"ttsProfile": "string",
"ttsType": "string",
"ttsVoice": "string"
},
"notifyCallLost": "EMAIL",
"twinMode": true
},
"extendedCallFowardFuncOutCalendar": {
"alternativeAccessCode": "string",
"alternativeNumber": "string",
"alternativeNumberRingTime": 0,
"confirmRequired": true,
"notifyCallFile": {
"content": "string",
"duration": 0,
"erasable": true,
"file": "string",
"musicOnHold": true,
"name": "string",
"producedByTTS": true,
"ttsLanguage": "string",
"ttsProfile": "string",
"ttsType": "string",
"ttsVoice": "string"
},
"notifyCallLost": "EMAIL",
"twinMode": true
},
"notifyCallLost": "EMAIL",
"ringTimeInCalendar": 0,
"ringTimeOutCalendar": 0,
"status": "ENABLE_ALL"
}
},
"cliCallForwardEnabledValue": {
"defaultValue": true,
"enableDefault": true,
"value": true
},
"conference": {
"adminpin": "string",
"chooseLanguageEnable": true,
"closeByAdminHangupEnabled": true,
"countPresentMembersEnabled": true,
"enable": true,
"greetingMsg": {
"content": "string",
"duration": 0,
"erasable": true,
"file": "string",
"musicOnHold": true,
"name": "string",
"producedByTTS": true,
"ttsLanguage": "string",
"ttsProfile": "string",
"ttsType": "string",
"ttsVoice": "string"
},
"language": "IT",
"musicOnHoldEnabled": true,
"name": "string",
"notifyAccessEnabled": true,
"notifyTone": true,
"number": "string",
"ownerUser": "string",
"publicNumber": true,
"userAnnounceEnabled": true,
"userpin": "string",
"volMenuEnabled": true,
"waitAdmin": true
},
"configurationPermissionClass": {
"callFowardSettings": {
"property1": {
"actionInCalendar": "DEFAULT",
"actionOutCalendar": "DEFAULT",
"calendarEnable": "DEFAULT",
"context": "ENABLE_FROM_PHONE",
"notifyCallLost": "DEFAULT",
"permission": "DEFAULT",
"ringTimeInCalendar": "DEFAULT",
"ringTimeOutCalendar": "DEFAULT",
"status": "DEFAULT"
},
"property2": {
"actionInCalendar": "DEFAULT",
"actionOutCalendar": "DEFAULT",
"calendarEnable": "DEFAULT",
"context": "ENABLE_FROM_PHONE",
"notifyCallLost": "DEFAULT",
"permission": "DEFAULT",
"ringTimeInCalendar": "DEFAULT",
"ringTimeOutCalendar": "DEFAULT",
"status": "DEFAULT"
}
},
"conference": {
"adminpin": "DEFAULT",
"closeByAdminHangupEnabled": "DEFAULT",
"countPresentMembersEnabled": "DEFAULT",
"enable": "DEFAULT",
"greetingMsg": "DEFAULT",
"musicOnHoldEnabled": "DEFAULT",
"name": "DEFAULT",
"notifyAccessEnabled": "DEFAULT",
"notifyTone": "DEFAULT",
"number": "DEFAULT",
"permission": "DEFAULT",
"userAnnounceEnabled": "DEFAULT",
"userpin": "DEFAULT",
"volMenuEnabled": "DEFAULT",
"waitAdmin": "DEFAULT"
},
"description": "string",
"directory": {
"customFields": {
"property1": "DEFAULT",
"property2": "DEFAULT"
},
"email": "DEFAULT",
"fax": "DEFAULT",
"homePhone": "DEFAULT",
"mobilePhone": "DEFAULT",
"otherPhone": "DEFAULT",
"permission": "DEFAULT"
},
"faxes": "DEFAULT",
"idTVox": 0,
"name": "DEFAULT",
"password": "DEFAULT",
"permission": "DEFAULT",
"pinForPhoneServices": "DEFAULT",
"surname": "DEFAULT",
"username": "DEFAULT",
"voicemail": {
"maxmsg": "DEFAULT",
"password": "DEFAULT",
"permission": "DEFAULT",
"toAttachFile": "DEFAULT",
"toDeleteFile": "DEFAULT",
"toSendEmail": "DEFAULT"
}
},
"currentDevices": [
{
"clientVersion": "string",
"platform": "WEB"
}
],
"customConfigurationPermissionClass": {
"callFowardSettings": {
"property1": {
"actionInCalendar": "DEFAULT",
"actionOutCalendar": "DEFAULT",
"calendarEnable": "DEFAULT",
"context": "ENABLE_FROM_PHONE",
"notifyCallLost": "DEFAULT",
"permission": "DEFAULT",
"ringTimeInCalendar": "DEFAULT",
"ringTimeOutCalendar": "DEFAULT",
"status": "DEFAULT"
},
"property2": {
"actionInCalendar": "DEFAULT",
"actionOutCalendar": "DEFAULT",
"calendarEnable": "DEFAULT",
"context": "ENABLE_FROM_PHONE",
"notifyCallLost": "DEFAULT",
"permission": "DEFAULT",
"ringTimeInCalendar": "DEFAULT",
"ringTimeOutCalendar": "DEFAULT",
"status": "DEFAULT"
}
},
"conference": {
"adminpin": "DEFAULT",
"closeByAdminHangupEnabled": "DEFAULT",
"countPresentMembersEnabled": "DEFAULT",
"enable": "DEFAULT",
"greetingMsg": "DEFAULT",
"musicOnHoldEnabled": "DEFAULT",
"name": "DEFAULT",
"notifyAccessEnabled": "DEFAULT",
"notifyTone": "DEFAULT",
"number": "DEFAULT",
"permission": "DEFAULT",
"userAnnounceEnabled": "DEFAULT",
"userpin": "DEFAULT",
"volMenuEnabled": "DEFAULT",
"waitAdmin": "DEFAULT"
},
"description": "string",
"directory": {
"customFields": {
"property1": "DEFAULT",
"property2": "DEFAULT"
},
"email": "DEFAULT",
"fax": "DEFAULT",
"homePhone": "DEFAULT",
"mobilePhone": "DEFAULT",
"otherPhone": "DEFAULT",
"permission": "DEFAULT"
},
"faxes": "DEFAULT",
"idTVox": 0,
"name": "DEFAULT",
"password": "DEFAULT",
"permission": "DEFAULT",
"pinForPhoneServices": "DEFAULT",
"surname": "DEFAULT",
"username": "DEFAULT",
"voicemail": {
"maxmsg": "DEFAULT",
"password": "DEFAULT",
"permission": "DEFAULT",
"toAttachFile": "DEFAULT",
"toDeleteFile": "DEFAULT",
"toSendEmail": "DEFAULT"
}
},
"customer": {
"display": "string",
"id": "string"
},
"devices": [
{
"mcsEnabled": true,
"type": "WEB_CLIENT",
"webrtcEnabled": true
}
],
"directory": {
"customCli": "string",
"customCliType": "CUST",
"customFields": {
"property1": "string",
"property2": "string"
},
"email": "string",
"fax": "string",
"homePhone": "string",
"mobilePhone": "string",
"otherPhone": "string"
},
"disaNumbers": {
"property1": {
"key": {
"bpmId": 0,
"calledNumber": "string",
"calledNumberRegExp": true,
"callerNumber": "string",
"callerNumberRegExp": true,
"description": "string",
"disaEnable": true,
"disaRetry": 0,
"followCalendar": "ENABLED",
"id": 0,
"name": "string",
"serviceType": "IVR",
"type": "USER",
"value": "string"
},
"value": true
},
"property2": {
"key": {
"bpmId": 0,
"calledNumber": "string",
"calledNumberRegExp": true,
"callerNumber": "string",
"callerNumberRegExp": true,
"description": "string",
"disaEnable": true,
"disaRetry": 0,
"followCalendar": "ENABLED",
"id": 0,
"name": "string",
"serviceType": "IVR",
"type": "USER",
"value": "string"
},
"value": true
}
},
"dndConfValue": {
"defaultValue": "ENABLED",
"enableDefault": true,
"value": "ENABLED"
},
"dndNotifyValue": {
"defaultValue": "ENABLED",
"enableDefault": true,
"value": "ENABLED"
},
"enableAutoPhoneLock": true,
"enableCallFowardExtended": true,
"enableRedirectionToExternalNumer": true,
"faxes": [
{
"administrator": true,
"fax": {
"identifier": 0,
"name": "string"
},
"receiving": "MAIL",
"receivingEnabled": true,
"sending": "MAIL",
"sendingEnabled": true
}
],
"feedbackClientSettings": {
"maxAttachmentsSizeValue": {
"defaultValue": 0,
"enableDefault": true,
"value": 0
},
"sendFeedbackEnabledValue": {
"defaultValue": true,
"enableDefault": true,
"value": true
},
"webClientLogMinutesValue": {
"defaultValue": 0,
"enableDefault": true,
"value": 0
},
"webClientLogValue": {
"defaultValue": true,
"enableDefault": true,
"value": true
}
},
"forgetContactPermission": true,
"knowledgeBasePermission": "DISABLED",
"language": "IT",
"mcDisplayName": "string",
"name": "string",
"number": "string",
"pendingWarnings": [
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
],
"suppressed": [
{
"localizedMessage": null,
"message": null,
"stackTrace": null
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{}
]
}
]
}
],
"pickupGroups": [
{
"id": 0,
"name": "string",
"number": "string"
}
],
"pinForPhoneServices": "string",
"profili": [
{
"abilitazioneProfile": {
"descrizione": "string",
"id": 0
},
"filtroProfile": {
"descrizione": "string",
"id": 0
},
"id": 0,
"label": "string",
"maxCallInbound": 0,
"recNoticeEnabled": true,
"registration": "DISABLED",
"tvoxStatus": "READY",
"type": "UC",
"username": "string"
}
],
"publicNumbers": [
{
"bpmId": 0,
"calledNumber": "string",
"calledNumberRegExp": true,
"callerNumber": "string",
"callerNumberRegExp": true,
"description": "string",
"disaEnable": true,
"disaRetry": 0,
"followCalendar": "ENABLED",
"id": 0,
"name": "string",
"serviceType": "IVR",
"type": "USER",
"value": "string"
}
],
"publicUsername": "string",
"pwdIntrusion": "string",
"rocketChatConfiguration": {
"roles": [
"ADMIN"
]
},
"shortNumberLists": [
{
"autoInsert": true,
"id": 0,
"name": "string",
"shortNumber": "string"
}
],
"site": {
"cliCallForwardEnabled": true,
"id": 0,
"name": "string"
},
"supportUserId": 0,
"surname": "string",
"ucConf": {
"chatEnabled": true,
"externalLookupEnabled": true,
"meetingCreatePermission": {
"defaultValue": true,
"enableDefault": true,
"value": true
},
"outlookPluginEnabled": true,
"persistentInteractionsEnabled": true,
"personalAddressbookEnabled": {
"defaultValue": true,
"enableDefault": true,
"value": true
},
"presenceActive": true,
"roomsVisibilityEnabled": true,
"sendingSMSEnabled": true,
"visible": true
},
"userRoles": [
"string"
],
"username": "string",
"voicemail": {
"language": "IT",
"maxmsg": 0,
"password": "string",
"toAttachFile": true,
"toDeleteFile": true,
"toSendEmail": true,
"uniqueid": 0
},
"zendeskAgentId": 0
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 404 | Not Found | Error: Object was not found. | GenericObjectWasNotFoundException |
| default | Default | TVox user | TVoxUser |
User devices
User devices management
Get user devices
Code samples
GET %3CTVOX_HOST%3E/tvox/rest/user-devices/user/string HTTP/1.1
Accept: application/json
Cookie: JSESSIONID=SESSION_ID
Host:
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https:///%3CTVOX_HOST%3E/tvox/rest/user-devices/user/string",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Accept: application/json",
"Cookie: JSESSIONID=SESSION_ID"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
curl --request GET \
--url https:///%3CTVOX_HOST%3E/tvox/rest/user-devices/user/string \
--header 'Accept: application/json' \
--header 'Cookie: JSESSIONID=SESSION_ID'
HttpResponse<String> response = Unirest.get("https:///%3CTVOX_HOST%3E/tvox/rest/user-devices/user/string")
.header("Accept", "application/json")
.header("Cookie", "JSESSIONID=SESSION_ID")
.asString();
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https:///%3CTVOX_HOST%3E/tvox/rest/user-devices/user/string"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Accept", "application/json")
req.Header.Add("Cookie", "JSESSIONID=SESSION_ID")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("GET", "https:///%3CTVOX_HOST%3E/tvox/rest/user-devices/user/string");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Cookie", "JSESSIONID=SESSION_ID");
xhr.send(data);
const http = require("https");
const options = {
"method": "GET",
"hostname": "",
"port": null,
"path": "%3CTVOX_HOST%3E/tvox/rest/user-devices/user/string",
"headers": {
"Accept": "application/json",
"Cookie": "JSESSIONID=SESSION_ID"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
import http.client
conn = http.client.HTTPSConnection("")
headers = {
'Accept': "application/json",
'Cookie': "JSESSIONID=SESSION_ID"
}
conn.request("GET", "%3CTVOX_HOST%3E/tvox/rest/user-devices/user/string", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https:///%3CTVOX_HOST%3E/tvox/rest/user-devices/user/string")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/json'
request["Cookie"] = 'JSESSIONID=SESSION_ID'
response = http.request(request)
puts response.read_body
GET /rest/user-devices/user/{userId}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| userId | path | string | true | User id of the user |
| type | query | string | false | User device type to filter |
| chosenByClient | query | boolean | false | User device chosen by client |
Enumerated Values
| Parameter | Value |
|---|---|
| type | WEB |
| type | APP |
| type | SIP |
| type | EXTERNAL |
Responses
Example responses
default Response
{
"chosenByClient": true,
"extension": "string",
"owner": {
"defaultCallableNumber": "string",
"name": "string",
"publicUsername": "string",
"surname": "string",
"username": "string"
},
"rec": "AUT",
"registrationStatus": {
"ipAddress": "string",
"status": "REGISTERED",
"userAgent": "string"
},
"smartWorkingEnabled": true,
"type": "WEB"
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 401 | Unauthorized | Error: Authorization required. Request is not authenticated or current user session is expired | AuthorizationRequiredException |
| 404 | Not Found | Error: Object was not found. | GenericObjectWasNotFoundException |
| 412 | Precondition Failed | Error: Object required. A required field is missing or empty | GenericObjectRequiredException |
| default | Default | List of user devices | [UserDevice] |
Schemas
APIVersion
TVox and API version
Properties
{
"tvoxVersion": "string",
"webapiVersion": "string"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| tvoxVersion | string | false | none | TVox Version |
| webapiVersion | string | false | none | API Version |
Abilitazione
Enabling for outgoing calls
Properties
{
"descrizione": "string",
"id": 0
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| descrizione | string | true | none | Enabling description |
| id | integer(int32) | true | none | Enabling ID |
AccessList
Access list
Properties
{
"actionDescription": "string",
"actionType": "HANGUP",
"actionValue": "string",
"id": 0,
"name": "string",
"type": "BLACK",
"values": {
"property1": "string",
"property2": "string"
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| actionDescription | string | false | none | Action description |
| actionType | string | false | none | Action type |
| actionValue | string | false | none | Action value |
| id | integer(int32) | false | none | Id |
| name | string | false | none | Name |
| type | string | false | none | Type |
| values | object | false | none | Values |
| » additionalProperties | string | false | none | Values |
Enumerated Values
| Property | Value |
|---|---|
| actionType | HANGUP |
| actionType | DIAL_SERV |
| actionType | DIAL_USER |
| actionType | DIAL_EXTEN |
| type | BLACK |
| type | WHITE |
AddressbookContactCustom
List of contact custom fields
Properties
{
"key": "CUSTOM_01",
"value": "string"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| key | string | false | none | none |
| value | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| key | CUSTOM_01 |
| key | CUSTOM_02 |
| key | CUSTOM_03 |
| key | CUSTOM_04 |
| key | CUSTOM_05 |
| key | CUSTOM_06 |
| key | CUSTOM_07 |
| key | CUSTOM_08 |
| key | CUSTOM_09 |
| key | CUSTOM_10 |
AddressbookContactEmail
List of contact emails (max: 10)
Properties
{
"type": "INTERNET_WORK",
"value": "string"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | string | false | none | none |
| value | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| type | INTERNET_WORK |
| type | INTERNET_HOME |
AddressbookContactExternal
External addressbook contact
Properties
{
"addressbookBackendId": "string",
"agentNote": "string",
"cap": "string",
"categories": [
"string"
],
"city": "string",
"company": "string",
"country": "string",
"customFields": [
{
"key": "CUSTOM_01",
"value": "string"
}
],
"department": "string",
"district": "string",
"emails": [
{
"type": "INTERNET_WORK",
"value": "string"
}
],
"id": "string",
"name": "string",
"note": "string",
"numbers": [
{
"type": "FAX",
"value": "string"
}
],
"otherName": "string",
"role": "string",
"street": "string",
"surname": "string",
"vip": true,
"webSites": [
{
"type": "WORK",
"value": "string"
}
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| addressbookBackendId | string | false | none | Addressbook backend id in which to create or update the contact. If not specified, the external addressbook default backend is used. |
| agentNote | string | false | none | Contact agent note |
| cap | string | false | none | Contact cap |
| categories | [string] | false | none | List of contact categories |
| city | string | false | none | Contact city |
| company | string | false | none | Contact company (one of name, surname or company must be specified) |
| country | string | false | none | Contact country |
| customFields | [AddressbookContactCustom] | false | none | List of contact custom fields |
| department | string | false | none | Contact department |
| district | string | false | none | Contact district |
| emails | [AddressbookContactEmail] | false | none | List of contact emails (max: 10) |
| id | string | false | none | Contact id |
| name | string | false | none | Contact name (one of name, surname or company must be specified) |
| note | string | false | none | Contact note |
| numbers | [AddressbookContactNumber] | false | none | List of contact numbers (max: 10) |
| otherName | string | false | none | Contact other name |
| role | string | false | none | Contact role |
| street | string | false | none | Contact street |
| surname | string | false | none | Contact surname (one of name, surname or company must be specified) |
| vip | boolean | true | none | Contact vip |
| webSites | [AddressbookContactWebSite] | false | none | List of contact web sites (max: 3) |
AddressbookContactNumber
List of contact numbers (max: 10)
Properties
{
"type": "FAX",
"value": "string"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | string | false | none | none |
| value | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| type | FAX |
| type | HOME |
| type | CELL |
| type | WORK |
| type | CELL_WORK |
| type | FAX_WORK |
| type | FAX_HOME |
| type | CELL_HOME |
| type | MAIN |
| type | OTHER |
AddressbookContactWebSite
List of contact web sites (max: 3)
Properties
{
"type": "WORK",
"value": "string"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | string | false | none | none |
| value | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| type | WORK |
| type | HOME |
Attachment
Attachment
Properties
{
"data": "string",
"filename": "string",
"id": 0,
"mime-type": "string",
"preferences": {
"property1": "string",
"property2": "string"
},
"size": "string"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| data | string | false | none | Base64 of file to update |
| filename | string | false | none | File name |
| id | integer(int32) | false | none | Attachment id |
| mime-type | string | false | none | File type |
| preferences | object | false | none | Hash for additional information |
| » additionalProperties | string | false | none | Hash for additional information |
| size | string | false | none | Size of attachment |
AudioFile
Audio file
Properties
{
"content": "string",
"duration": 0,
"erasable": true,
"file": "string",
"musicOnHold": true,
"name": "string",
"producedByTTS": true,
"ttsLanguage": "string",
"ttsProfile": "string",
"ttsType": "string",
"ttsVoice": "string"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| content | string | false | none | Content |
| duration | number(double) | false | none | Duration |
| erasable | boolean | false | none | Erasable |
| file | string | false | none | File |
| musicOnHold | boolean | false | none | Music On Hold enabled |
| name | string | false | none | Name |
| producedByTTS | boolean | false | none | Produced by TTS |
| ttsLanguage | string | false | none | TTS language |
| ttsProfile | string | false | none | TTS profile |
| ttsType | string | false | none | TTS type |
| ttsVoice | string | false | none | TTS voice |
AuthorizationRequiredException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"sessionId": "string"
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » sessionId | string | false | none | none |
BranchOfficeEnabledException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"className": "string",
"field": "string",
"value": {}
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » className | string | false | none | none |
| » field | string | false | none | none |
| » value | object | false | none | none |
BranchOfficeHeadquarterNotEnabledException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"className": "string",
"field": "string",
"value": {}
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » className | string | false | none | none |
| » field | string | false | none | none |
| » value | object | false | none | none |
CacheLimitSizeExceededException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"exceededByte": 0
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » exceededByte | integer(int64) | false | none | none |
CalendarEventDeleteException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"calendarEventId": "string",
"calendarId": "string"
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » calendarEventId | string | false | none | none |
| » calendarId | string | false | none | none |
CallFoward
Call Forward
Properties
{
"actionInCalendar": {
"actionToDo": "DIAL"
},
"actionOutCalendar": {
"actionToDo": "DIAL"
},
"calendarEnable": true,
"context": "ENABLE_FROM_PHONE",
"extendedCallFowardFuncInCalendar": {
"alternativeAccessCode": "string",
"alternativeNumber": "string",
"alternativeNumberRingTime": 0,
"confirmRequired": true,
"notifyCallFile": {
"content": "string",
"duration": 0,
"erasable": true,
"file": "string",
"musicOnHold": true,
"name": "string",
"producedByTTS": true,
"ttsLanguage": "string",
"ttsProfile": "string",
"ttsType": "string",
"ttsVoice": "string"
},
"notifyCallLost": "EMAIL",
"twinMode": true
},
"extendedCallFowardFuncOutCalendar": {
"alternativeAccessCode": "string",
"alternativeNumber": "string",
"alternativeNumberRingTime": 0,
"confirmRequired": true,
"notifyCallFile": {
"content": "string",
"duration": 0,
"erasable": true,
"file": "string",
"musicOnHold": true,
"name": "string",
"producedByTTS": true,
"ttsLanguage": "string",
"ttsProfile": "string",
"ttsType": "string",
"ttsVoice": "string"
},
"notifyCallLost": "EMAIL",
"twinMode": true
},
"notifyCallLost": "EMAIL",
"ringTimeInCalendar": 0,
"ringTimeOutCalendar": 0,
"status": "ENABLE_ALL"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| actionInCalendar | CallFowardActionToDo | false | none | Call Forward action to do |
| actionOutCalendar | CallFowardActionToDo | false | none | Call Forward action to do |
| calendarEnable | boolean | false | none | Calendar enabled |
| context | string | false | none | Context |
| extendedCallFowardFuncInCalendar | CallFowardMobility | false | none | Call Forward Mobility |
| extendedCallFowardFuncOutCalendar | CallFowardMobility | false | none | Call Forward Mobility |
| notifyCallLost | string | false | none | Call lost notify mode |
| ringTimeInCalendar | integer(int32) | false | none | Ring time in calendar |
| ringTimeOutCalendar | integer(int32) | false | none | Ring time out calendar |
| status | string | false | none | Enable status |
Enumerated Values
| Property | Value |
|---|---|
| context | ENABLE_FROM_PHONE |
| context | ALWAYS |
| context | CHANUNAVAIL |
| context | BUSY |
| context | NOANSWER |
| context | NOT_PRESENT |
| notifyCallLost | |
| notifyCallLost | SMS |
| notifyCallLost | ALL |
| status | ENABLE_ALL |
| status | ENABLE_INTERNAL |
| status | ENABLE_EXTERNAL |
| status | DISABLE |
CallFowardActionBackPO
Properties
{
"actionToDo": "DIAL",
"serviceCode": "string"
}
allOf - discriminator: CallFowardActionToDo.actionToDo
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | CallFowardActionToDo | false | none | Call Forward action to do |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » serviceCode | string | false | none | none |
CallFowardActionDialNumber
Properties
{
"actionToDo": "DIAL",
"accessCode": "string",
"number": "string"
}
allOf - discriminator: CallFowardActionToDo.actionToDo
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | CallFowardActionToDo | false | none | Call Forward action to do |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » accessCode | string | false | none | none |
| » number | string | false | none | none |
CallFowardActionHangup
Properties
{
"actionToDo": "DIAL"
}
None
CallFowardActionPlay
Properties
{
"actionToDo": "DIAL",
"file": {
"content": "string",
"duration": 0,
"erasable": true,
"file": "string",
"musicOnHold": true,
"name": "string",
"producedByTTS": true,
"ttsLanguage": "string",
"ttsProfile": "string",
"ttsType": "string",
"ttsVoice": "string"
}
}
allOf - discriminator: CallFowardActionToDo.actionToDo
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | CallFowardActionToDo | false | none | Call Forward action to do |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » file | AudioFile | false | none | Audio file |
CallFowardActionToDo
Call Forward action to do
Properties
{
"actionToDo": "DIAL"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| actionToDo | string | false | none | Action to do type |
Enumerated Values
| Property | Value |
|---|---|
| actionToDo | DIAL |
| actionToDo | BACK_PO |
| actionToDo | VOICEMAIL |
| actionToDo | HANGUP |
| actionToDo | PLAY |
CallFowardActionVoicemail
Properties
{
"actionToDo": "DIAL"
}
None
CallFowardConfigurationPermission
Call Forward settings
Properties
{
"actionInCalendar": "DEFAULT",
"actionOutCalendar": "DEFAULT",
"calendarEnable": "DEFAULT",
"context": "ENABLE_FROM_PHONE",
"notifyCallLost": "DEFAULT",
"permission": "DEFAULT",
"ringTimeInCalendar": "DEFAULT",
"ringTimeOutCalendar": "DEFAULT",
"status": "DEFAULT"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| actionInCalendar | string | false | none | none |
| actionOutCalendar | string | false | none | none |
| calendarEnable | string | false | none | none |
| context | string | false | none | none |
| notifyCallLost | string | false | none | none |
| permission | string | false | none | none |
| ringTimeInCalendar | string | false | none | none |
| ringTimeOutCalendar | string | false | none | none |
| status | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| actionInCalendar | DEFAULT |
| actionInCalendar | NONE |
| actionInCalendar | READ |
| actionInCalendar | READ_WRITE |
| actionInCalendar | READ_ADD |
| actionInCalendar | READ_WRITE_ADD |
| actionOutCalendar | DEFAULT |
| actionOutCalendar | NONE |
| actionOutCalendar | READ |
| actionOutCalendar | READ_WRITE |
| actionOutCalendar | READ_ADD |
| actionOutCalendar | READ_WRITE_ADD |
| calendarEnable | DEFAULT |
| calendarEnable | NONE |
| calendarEnable | READ |
| calendarEnable | READ_WRITE |
| calendarEnable | READ_ADD |
| calendarEnable | READ_WRITE_ADD |
| context | ENABLE_FROM_PHONE |
| context | ALWAYS |
| context | CHANUNAVAIL |
| context | BUSY |
| context | NOANSWER |
| context | NOT_PRESENT |
| notifyCallLost | DEFAULT |
| notifyCallLost | NONE |
| notifyCallLost | READ |
| notifyCallLost | READ_WRITE |
| notifyCallLost | READ_ADD |
| notifyCallLost | READ_WRITE_ADD |
| permission | DEFAULT |
| permission | NONE |
| permission | READ |
| permission | READ_WRITE |
| permission | READ_ADD |
| permission | READ_WRITE_ADD |
| ringTimeInCalendar | DEFAULT |
| ringTimeInCalendar | NONE |
| ringTimeInCalendar | READ |
| ringTimeInCalendar | READ_WRITE |
| ringTimeInCalendar | READ_ADD |
| ringTimeInCalendar | READ_WRITE_ADD |
| ringTimeOutCalendar | DEFAULT |
| ringTimeOutCalendar | NONE |
| ringTimeOutCalendar | READ |
| ringTimeOutCalendar | READ_WRITE |
| ringTimeOutCalendar | READ_ADD |
| ringTimeOutCalendar | READ_WRITE_ADD |
| status | DEFAULT |
| status | NONE |
| status | READ |
| status | READ_WRITE |
| status | READ_ADD |
| status | READ_WRITE_ADD |
CallFowardMobility
Call Forward Mobility
Properties
{
"alternativeAccessCode": "string",
"alternativeNumber": "string",
"alternativeNumberRingTime": 0,
"confirmRequired": true,
"notifyCallFile": {
"content": "string",
"duration": 0,
"erasable": true,
"file": "string",
"musicOnHold": true,
"name": "string",
"producedByTTS": true,
"ttsLanguage": "string",
"ttsProfile": "string",
"ttsType": "string",
"ttsVoice": "string"
},
"notifyCallLost": "EMAIL",
"twinMode": true
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| alternativeAccessCode | string | false | none | Alternative access code |
| alternativeNumber | string | false | none | Alternative number |
| alternativeNumberRingTime | integer(int32) | false | none | Alternative number ring time |
| confirmRequired | boolean | false | none | Confirm required |
| notifyCallFile | AudioFile | false | none | Audio file |
| notifyCallLost | string | false | none | Notify call lost |
| twinMode | boolean | false | none | Twin mode |
Enumerated Values
| Property | Value |
|---|---|
| notifyCallLost | |
| notifyCallLost | SMS |
CertificateUploadApplyGenericErrorException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
]
}
None
CertificateUploadApplyWrongPasswordException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
]
}
None
CertificateUploadVerifyGenericErrorException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
]
}
None
CertificateUploadVerifyInvalidCertWithKeyException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
]
}
None
CertificateUploadVerifyWrongPasswordException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
]
}
None
ChatContactIdentifier
Chat contact identifier
Properties
{
"displayName": "string",
"name": "string",
"surname": "string",
"type": "USER",
"uid": "string",
"username": "string",
"value": "string"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| displayName | string | false | none | Display name |
| name | string | false | none | Name |
| surname | string | false | none | Surname |
| type | string | false | none | Contact type |
| uid | string | false | none | Uid - unique id from T4You |
| username | string | false | none | If type USER - user id |
| value | string | false | none | Contact value if no ids are present |
Enumerated Values
| Property | Value |
|---|---|
| type | USER |
| type | REMOTE_USER |
| type | SERVICE |
| type | SERVICE_CODE |
| type | SHORT_NUMBER |
| type | EXTERNAL_ITEM |
| type | EXTERNAL_ORGANIZATION |
| type | PERSONAL_ITEM |
| type | UNKNOWN |
| type | MULTIPLE |
| type | MEETING |
| type | ERROR |
| type | DELAYED |
| type | ANONYMOUS |
ChatHistoryMessage
Chat history message
Properties
{
"agent": {
"displayName": "string",
"name": "string",
"surname": "string",
"type": "USER",
"uid": "string",
"username": "string",
"value": "string"
},
"attachment": {
"file": "string",
"fileName": "string",
"mimeType": "string"
},
"channelType": "WIDGET",
"customer": {
"displayName": "string",
"name": "string",
"surname": "string",
"type": "USER",
"uid": "string",
"username": "string",
"value": "string"
},
"id": "string",
"insertTime": "2019-08-24T14:15:22Z",
"message": "string",
"messageId": "string",
"messageType": "OPEN_SESSION",
"readTime": "2019-08-24T14:15:22Z",
"receivedTime": "2019-08-24T14:15:22Z",
"sender": "AGENT",
"service": {
"bpmProcessId": 0,
"code": "string",
"exten": "string",
"name": "string",
"registration": "DISABLED",
"type": "IVR",
"version": 0
},
"sessionId": "string",
"updateTime": "2019-08-24T14:15:22Z"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| agent | ChatContactIdentifier | false | none | Chat contact identifier |
| attachment | ChatHistoryMessageAttachment | false | none | Chat message attachment |
| channelType | string | true | none | Message channel type (WIDGET or WHATSAPP_TWILIO) |
| customer | ChatContactIdentifier | false | none | Chat contact identifier |
| id | string | true | none | Internal id |
| insertTime | string(date-time) | false | none | Message insert time |
| message | string | false | none | Message |
| messageId | string | true | none | Message id |
| messageType | string | true | none | Message type (one of OPEN_SESSION, MESSAGE, CLOSED_SESSION |
| readTime | string(date-time) | false | none | Message read time |
| receivedTime | string(date-time) | false | none | Message received time |
| sender | string | true | none | Message sender type (AGENT or CUSTOMER) |
| service | ServiceBase | true | none | Service |
| sessionId | string | true | none | Session id |
| updateTime | string(date-time) | false | none | Message update time |
Enumerated Values
| Property | Value |
|---|---|
| channelType | WIDGET |
| channelType | WHATSAPP_TWILIO |
| messageType | OPEN_SESSION |
| messageType | MESSAGE |
| messageType | CLOSED_SESSION |
| sender | AGENT |
| sender | CUSTOMER |
ChatHistoryMessageAttachment
Chat message attachment
Properties
{
"file": "string",
"fileName": "string",
"mimeType": "string"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| file | string | false | none | Attachment file path. File can be downloaded from url: https://TVOX_IP/im/ |
| fileName | string | false | none | Attachment file name |
| mimeType | string | false | none | Attachment file MIME type |
Component
Properties
{
"text": "string",
"type": "string"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| text | string | false | none | none |
| type | string | false | none | none |
Conference
Conference
Properties
{
"adminpin": "string",
"chooseLanguageEnable": true,
"closeByAdminHangupEnabled": true,
"countPresentMembersEnabled": true,
"enable": true,
"greetingMsg": {
"content": "string",
"duration": 0,
"erasable": true,
"file": "string",
"musicOnHold": true,
"name": "string",
"producedByTTS": true,
"ttsLanguage": "string",
"ttsProfile": "string",
"ttsType": "string",
"ttsVoice": "string"
},
"language": "IT",
"musicOnHoldEnabled": true,
"name": "string",
"notifyAccessEnabled": true,
"notifyTone": true,
"number": "string",
"ownerUser": "string",
"publicNumber": true,
"userAnnounceEnabled": true,
"userpin": "string",
"volMenuEnabled": true,
"waitAdmin": true
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| adminpin | string | false | none | Admin PIN |
| chooseLanguageEnable | boolean | false | none | Choose language enabled |
| closeByAdminHangupEnabled | boolean | false | none | Close by admin hangup enabled |
| countPresentMembersEnabled | boolean | false | none | Count present members enabled |
| enable | boolean | false | none | Enable |
| greetingMsg | AudioFile | false | none | Audio file |
| language | Language | false | none | Language |
| musicOnHoldEnabled | boolean | false | none | Music On Hold enabled |
| name | string | false | none | Name |
| notifyAccessEnabled | boolean | false | none | Notify access enabled |
| notifyTone | boolean | false | none | Notify tone |
| number | string | false | none | Number |
| ownerUser | string | false | none | Owner user |
| publicNumber | boolean | false | none | Public number |
| userAnnounceEnabled | boolean | false | none | User announce enabled |
| userpin | string | false | none | User PIN |
| volMenuEnabled | boolean | false | none | Vol menu enabled |
| waitAdmin | boolean | false | none | Wait admin |
ConferenceConfigurationPermission
Conference
Properties
{
"adminpin": "DEFAULT",
"closeByAdminHangupEnabled": "DEFAULT",
"countPresentMembersEnabled": "DEFAULT",
"enable": "DEFAULT",
"greetingMsg": "DEFAULT",
"musicOnHoldEnabled": "DEFAULT",
"name": "DEFAULT",
"notifyAccessEnabled": "DEFAULT",
"notifyTone": "DEFAULT",
"number": "DEFAULT",
"permission": "DEFAULT",
"userAnnounceEnabled": "DEFAULT",
"userpin": "DEFAULT",
"volMenuEnabled": "DEFAULT",
"waitAdmin": "DEFAULT"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| adminpin | string | false | none | none |
| closeByAdminHangupEnabled | string | false | none | none |
| countPresentMembersEnabled | string | false | none | none |
| enable | string | false | none | none |
| greetingMsg | string | false | none | none |
| musicOnHoldEnabled | string | false | none | none |
| name | string | false | none | none |
| notifyAccessEnabled | string | false | none | none |
| notifyTone | string | false | none | none |
| number | string | false | none | none |
| permission | string | false | none | none |
| userAnnounceEnabled | string | false | none | none |
| userpin | string | false | none | none |
| volMenuEnabled | string | false | none | none |
| waitAdmin | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| adminpin | DEFAULT |
| adminpin | NONE |
| adminpin | READ |
| adminpin | READ_WRITE |
| adminpin | READ_ADD |
| adminpin | READ_WRITE_ADD |
| closeByAdminHangupEnabled | DEFAULT |
| closeByAdminHangupEnabled | NONE |
| closeByAdminHangupEnabled | READ |
| closeByAdminHangupEnabled | READ_WRITE |
| closeByAdminHangupEnabled | READ_ADD |
| closeByAdminHangupEnabled | READ_WRITE_ADD |
| countPresentMembersEnabled | DEFAULT |
| countPresentMembersEnabled | NONE |
| countPresentMembersEnabled | READ |
| countPresentMembersEnabled | READ_WRITE |
| countPresentMembersEnabled | READ_ADD |
| countPresentMembersEnabled | READ_WRITE_ADD |
| enable | DEFAULT |
| enable | NONE |
| enable | READ |
| enable | READ_WRITE |
| enable | READ_ADD |
| enable | READ_WRITE_ADD |
| greetingMsg | DEFAULT |
| greetingMsg | NONE |
| greetingMsg | READ |
| greetingMsg | READ_WRITE |
| greetingMsg | READ_ADD |
| greetingMsg | READ_WRITE_ADD |
| musicOnHoldEnabled | DEFAULT |
| musicOnHoldEnabled | NONE |
| musicOnHoldEnabled | READ |
| musicOnHoldEnabled | READ_WRITE |
| musicOnHoldEnabled | READ_ADD |
| musicOnHoldEnabled | READ_WRITE_ADD |
| name | DEFAULT |
| name | NONE |
| name | READ |
| name | READ_WRITE |
| name | READ_ADD |
| name | READ_WRITE_ADD |
| notifyAccessEnabled | DEFAULT |
| notifyAccessEnabled | NONE |
| notifyAccessEnabled | READ |
| notifyAccessEnabled | READ_WRITE |
| notifyAccessEnabled | READ_ADD |
| notifyAccessEnabled | READ_WRITE_ADD |
| notifyTone | DEFAULT |
| notifyTone | NONE |
| notifyTone | READ |
| notifyTone | READ_WRITE |
| notifyTone | READ_ADD |
| notifyTone | READ_WRITE_ADD |
| number | DEFAULT |
| number | NONE |
| number | READ |
| number | READ_WRITE |
| number | READ_ADD |
| number | READ_WRITE_ADD |
| permission | DEFAULT |
| permission | NONE |
| permission | READ |
| permission | READ_WRITE |
| permission | READ_ADD |
| permission | READ_WRITE_ADD |
| userAnnounceEnabled | DEFAULT |
| userAnnounceEnabled | NONE |
| userAnnounceEnabled | READ |
| userAnnounceEnabled | READ_WRITE |
| userAnnounceEnabled | READ_ADD |
| userAnnounceEnabled | READ_WRITE_ADD |
| userpin | DEFAULT |
| userpin | NONE |
| userpin | READ |
| userpin | READ_WRITE |
| userpin | READ_ADD |
| userpin | READ_WRITE_ADD |
| volMenuEnabled | DEFAULT |
| volMenuEnabled | NONE |
| volMenuEnabled | READ |
| volMenuEnabled | READ_WRITE |
| volMenuEnabled | READ_ADD |
| volMenuEnabled | READ_WRITE_ADD |
| waitAdmin | DEFAULT |
| waitAdmin | NONE |
| waitAdmin | READ |
| waitAdmin | READ_WRITE |
| waitAdmin | READ_ADD |
| waitAdmin | READ_WRITE_ADD |
ContactIdentifier
Contact identifier - used on interaction and note
Properties
{
"type": "USER",
"uid": "string",
"username": "string",
"value": "string"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | string | false | none | Contact type |
| uid | string | false | none | Uid - unique id from T4You |
| username | string | false | none | If type USER - user id |
| value | string | false | none | Contact value if no ids are present |
Enumerated Values
| Property | Value |
|---|---|
| type | USER |
| type | REMOTE_USER |
| type | SERVICE |
| type | SERVICE_CODE |
| type | SHORT_NUMBER |
| type | EXTERNAL_ITEM |
| type | EXTERNAL_ORGANIZATION |
| type | PERSONAL_ITEM |
| type | UNKNOWN |
| type | MULTIPLE |
| type | MEETING |
| type | ERROR |
| type | DELAYED |
| type | ANONYMOUS |
ContactIdentifierWithUserInformations
Result list
Properties
{
"displayName": "string",
"email": "string",
"language": "IT",
"name": "string",
"publicUsername": "string",
"serviceCodes": [
"string"
],
"surname": "string",
"type": "USER",
"uid": "string",
"userIdMc1002": 0,
"username": "string",
"value": "string"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| displayName | string | false | none | Display name |
| string | false | none | none | |
| language | Language | false | none | Language |
| name | string | false | none | none |
| publicUsername | string | false | none | none |
| serviceCodes | [string] | false | none | none |
| surname | string | false | none | none |
| type | string | false | none | Contact type |
| uid | string | false | none | Uid - unique id from T4You |
| userIdMc1002 | integer(int32) | false | none | none |
| username | string | false | none | If type USER - user id |
| value | string | false | none | Contact value if no ids are present |
Enumerated Values
| Property | Value |
|---|---|
| type | USER |
| type | REMOTE_USER |
| type | SERVICE |
| type | SERVICE_CODE |
| type | SHORT_NUMBER |
| type | EXTERNAL_ITEM |
| type | EXTERNAL_ORGANIZATION |
| type | PERSONAL_ITEM |
| type | UNKNOWN |
| type | MULTIPLE |
| type | MEETING |
| type | ERROR |
| type | DELAYED |
| type | ANONYMOUS |
ConvertFileException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"reason": "FILE_EXISTS"
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » reason | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| reason | FILE_EXISTS |
| reason | WRONG_PERMISSION |
| reason | UNMANAGED_FILE_FORMAT |
| reason | GENERIC_ERROR |
CustomerBase
Properties
{
"display": "string",
"id": "string"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| display | string | false | none | none |
| id | string | false | none | none |
DataNotAvailableException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"className": "string",
"field": "string",
"value": {}
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » className | string | false | none | none |
| » field | string | false | none | none |
| » value | object | false | none | none |
DatamodelCallAbilitation
Properties
{
"__typename": "string",
"description": "string",
"enabled": true,
"id": 0
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| __typename | string | false | none | none |
| description | string | false | none | none |
| enabled | boolean | false | none | none |
| id | integer(int32) | false | none | none |
DatamodelComparisonNumber
Properties
{
"operator": "NULL",
"value": [
0
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| operator | string | false | none | none |
| value | [integer] | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| operator | NULL |
| operator | EMPTY |
| operator | NOT_NULL |
| operator | NOT_EMPTY |
| operator | EQUAL |
| operator | NOT_EQUAL |
| operator | CONTAIN |
| operator | GREATER_THAN |
| operator | LESSER_THAN |
| operator | GREATER_EQUAL_THAN |
| operator | LESSER_EQUAL_THAN |
| operator | BETWEEN |
| operator | IN |
| operator | START_WITH |
| operator | END_WITH |
| operator | REGEXP |
DatamodelComparisonString
Properties
{
"operator": "NULL",
"regexp": "string",
"value": [
"string"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| operator | string | false | none | none |
| regexp | string | false | none | none |
| value | [string] | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| operator | NULL |
| operator | EMPTY |
| operator | NOT_NULL |
| operator | NOT_EMPTY |
| operator | EQUAL |
| operator | NOT_EQUAL |
| operator | CONTAIN |
| operator | START_WITH |
| operator | END_WITH |
| operator | IN |
| operator | REGEXP |
DatamodelComparisonTime
Properties
{
"operator": "NULL",
"value": "string",
"valueLeft": "string",
"valueRight": "string"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| operator | string | false | none | none |
| value | string | false | none | none |
| valueLeft | string | false | none | none |
| valueRight | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| operator | NULL |
| operator | EMPTY |
| operator | NOT_NULL |
| operator | NOT_EMPTY |
| operator | EQUAL |
| operator | NOT_EQUAL |
| operator | GREATER_THAN |
| operator | GREATER_EQUAL_THAN |
| operator | LESSER_THAN |
| operator | LESSER_EQUAL_THAN |
| operator | BETWEEN |
DatamodelPowerDialerCampaign
Properties
{
"SMSLimit": 0,
"SMSSequencePosition": 0,
"__typename": "string",
"abilitation": {
"__typename": "string",
"description": "string",
"enabled": true,
"id": 0
},
"enabled": true,
"id": 0,
"instantMessagingExternalAccountPhoneID": "string",
"instantMessagingLimit": 0,
"instantMessagingSequencePosition": 0,
"instantMessagingTemplate": "string",
"list": [
{
"__typename": "string",
"busy": {
"__typename": "string",
"attempts": 0,
"interval": 0
},
"cancel": {
"__typename": "string",
"attempts": 0,
"interval": 0
},
"congestion": {
"__typename": "string",
"attempts": 0,
"interval": 0
},
"id": 0,
"name": "string",
"noAnswer": {
"__typename": "string",
"attempts": 0,
"interval": 0
},
"tvoxClosed": {
"__typename": "string",
"attempts": 0,
"interval": 0
}
}
],
"mailLimit": 0,
"mailSequencePosition": 0,
"massiveMailLimit": 0,
"massiveMailSequencePosition": 0,
"massiveSMSLimit": 0,
"massiveSMSSequencePosition": 0,
"name": "string",
"openFrom": "string",
"openTo": "string",
"priority": 0,
"service": {
"__typename": "string",
"code": "string",
"description": "string"
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| SMSLimit | integer(int32) | false | none | none |
| SMSSequencePosition | integer(int32) | false | none | none |
| __typename | string | false | none | none |
| abilitation | DatamodelCallAbilitation | false | none | none |
| enabled | boolean | false | none | none |
| id | integer(int32) | false | none | none |
| instantMessagingExternalAccountPhoneID | string | false | none | none |
| instantMessagingLimit | integer(int32) | false | none | none |
| instantMessagingSequencePosition | integer(int32) | false | none | none |
| instantMessagingTemplate | string | false | none | none |
| list | [DatamodelPowerDialerList] | false | none | none |
| mailLimit | integer(int32) | false | none | none |
| mailSequencePosition | integer(int32) | false | none | none |
| massiveMailLimit | integer(int32) | false | none | none |
| massiveMailSequencePosition | integer(int32) | false | none | none |
| massiveSMSLimit | integer(int32) | false | none | none |
| massiveSMSSequencePosition | integer(int32) | false | none | none |
| name | string | false | none | none |
| openFrom | string | false | none | none |
| openTo | string | false | none | none |
| priority | integer(int32) | false | none | none |
| service | DatamodelServiceDescription | false | none | none |
DatamodelPowerDialerInstantMessagingCampaignStatus
Properties
{
"__typename": "string",
"campaign": {
"SMSLimit": 0,
"SMSSequencePosition": 0,
"__typename": "string",
"abilitation": {
"__typename": "string",
"description": "string",
"enabled": true,
"id": 0
},
"enabled": true,
"id": 0,
"instantMessagingExternalAccountPhoneID": "string",
"instantMessagingLimit": 0,
"instantMessagingSequencePosition": 0,
"instantMessagingTemplate": "string",
"list": [
{
"__typename": "string",
"busy": {
"__typename": "string",
"attempts": 0,
"interval": 0
},
"cancel": {
"__typename": "string",
"attempts": 0,
"interval": 0
},
"congestion": {
"__typename": "string",
"attempts": 0,
"interval": 0
},
"id": 0,
"name": "string",
"noAnswer": {
"__typename": "string",
"attempts": 0,
"interval": 0
},
"tvoxClosed": {
"__typename": "string",
"attempts": 0,
"interval": 0
}
}
],
"mailLimit": 0,
"mailSequencePosition": 0,
"massiveMailLimit": 0,
"massiveMailSequencePosition": 0,
"massiveSMSLimit": 0,
"massiveSMSSequencePosition": 0,
"name": "string",
"openFrom": "string",
"openTo": "string",
"priority": 0,
"service": {
"__typename": "string",
"code": "string",
"description": "string"
}
},
"delivered": 0,
"error": 0,
"executionId": 0,
"fromPhoneNumber": "string",
"listId": 0,
"noStatusReceived": 0,
"read": 0,
"sent": 0,
"status": "string",
"totalContacts": 0
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| __typename | string | false | none | none |
| campaign | DatamodelPowerDialerCampaign | false | none | none |
| delivered | integer(int32) | false | none | none |
| error | integer(int32) | false | none | none |
| executionId | integer(int32) | false | none | none |
| fromPhoneNumber | string | false | none | none |
| listId | integer(int32) | false | none | none |
| noStatusReceived | integer(int32) | false | none | none |
| read | integer(int32) | false | none | none |
| sent | integer(int32) | false | none | none |
| status | string | false | none | none |
| totalContacts | integer(int32) | false | none | none |
DatamodelPowerDialerInstantMessagingHistory
Properties
{
"__typename": "string",
"campaign": {
"SMSLimit": 0,
"SMSSequencePosition": 0,
"__typename": "string",
"abilitation": {
"__typename": "string",
"description": "string",
"enabled": true,
"id": 0
},
"enabled": true,
"id": 0,
"instantMessagingExternalAccountPhoneID": "string",
"instantMessagingLimit": 0,
"instantMessagingSequencePosition": 0,
"instantMessagingTemplate": "string",
"list": [
{
"__typename": "string",
"busy": {
"__typename": "string",
"attempts": 0,
"interval": 0
},
"cancel": {
"__typename": "string",
"attempts": 0,
"interval": 0
},
"congestion": {
"__typename": "string",
"attempts": 0,
"interval": 0
},
"id": 0,
"name": "string",
"noAnswer": {
"__typename": "string",
"attempts": 0,
"interval": 0
},
"tvoxClosed": {
"__typename": "string",
"attempts": 0,
"interval": 0
}
}
],
"mailLimit": 0,
"mailSequencePosition": 0,
"massiveMailLimit": 0,
"massiveMailSequencePosition": 0,
"massiveSMSLimit": 0,
"massiveSMSSequencePosition": 0,
"name": "string",
"openFrom": "string",
"openTo": "string",
"priority": 0,
"service": {
"__typename": "string",
"code": "string",
"description": "string"
}
},
"contactCustumId": "string",
"contactItem": 0,
"contactUUID": "string",
"executionId": 0,
"imCloseTime": "string",
"imConversationExpiration": "string",
"imConversationId": "string",
"imConversationOriginType": "string",
"imEntryId": "string",
"imInsertTime": "string",
"imLastUpdateTime": "string",
"imMetadataDisplayPhoneNumber": "string",
"imMetadataPhoneNumberId": "string",
"imRecipientId": "string",
"imStatus": "string",
"imWamId": "string",
"insertTime": "string",
"listId": 0,
"messageCloseTime": "string",
"messageFromNumber": "string",
"messageId": "string",
"messageInsertTime": "string",
"messageParam01": "string",
"messageParam02": "string",
"messageParam03": "string",
"messageParam04": "string",
"messageParam05": "string",
"messageParam06": "string",
"messageParam07": "string",
"messageParam08": "string",
"messageParam09": "string",
"messageParam10": "string",
"messageParam11": "string",
"messageParam12": "string",
"messageParam13": "string",
"messageParam14": "string",
"messageParam15": "string",
"messageParam16": "string",
"messageParam17": "string",
"messageParam18": "string",
"messageParam19": "string",
"messageParam20": "string",
"messageParam21": "string",
"messageParam22": "string",
"messageParam23": "string",
"messageParam24": "string",
"messageParam25": "string",
"messageParam26": "string",
"messageParam27": "string",
"messageParam28": "string",
"messageParam29": "string",
"messageParam30": "string",
"messageResult": 0,
"messageTemplate": "string",
"messageToNumber": "string"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| __typename | string | false | none | none |
| campaign | DatamodelPowerDialerCampaign | false | none | none |
| contactCustumId | string | false | none | none |
| contactItem | integer(int32) | false | none | none |
| contactUUID | string | false | none | none |
| executionId | integer(int32) | false | none | none |
| imCloseTime | string | false | none | none |
| imConversationExpiration | string | false | none | none |
| imConversationId | string | false | none | none |
| imConversationOriginType | string | false | none | none |
| imEntryId | string | false | none | none |
| imInsertTime | string | false | none | none |
| imLastUpdateTime | string | false | none | none |
| imMetadataDisplayPhoneNumber | string | false | none | none |
| imMetadataPhoneNumberId | string | false | none | none |
| imRecipientId | string | false | none | none |
| imStatus | string | false | none | none |
| imWamId | string | false | none | none |
| insertTime | string | false | none | none |
| listId | integer(int32) | false | none | none |
| messageCloseTime | string | false | none | none |
| messageFromNumber | string | false | none | none |
| messageId | string | false | none | none |
| messageInsertTime | string | false | none | none |
| messageParam01 | string | false | none | none |
| messageParam02 | string | false | none | none |
| messageParam03 | string | false | none | none |
| messageParam04 | string | false | none | none |
| messageParam05 | string | false | none | none |
| messageParam06 | string | false | none | none |
| messageParam07 | string | false | none | none |
| messageParam08 | string | false | none | none |
| messageParam09 | string | false | none | none |
| messageParam10 | string | false | none | none |
| messageParam11 | string | false | none | none |
| messageParam12 | string | false | none | none |
| messageParam13 | string | false | none | none |
| messageParam14 | string | false | none | none |
| messageParam15 | string | false | none | none |
| messageParam16 | string | false | none | none |
| messageParam17 | string | false | none | none |
| messageParam18 | string | false | none | none |
| messageParam19 | string | false | none | none |
| messageParam20 | string | false | none | none |
| messageParam21 | string | false | none | none |
| messageParam22 | string | false | none | none |
| messageParam23 | string | false | none | none |
| messageParam24 | string | false | none | none |
| messageParam25 | string | false | none | none |
| messageParam26 | string | false | none | none |
| messageParam27 | string | false | none | none |
| messageParam28 | string | false | none | none |
| messageParam29 | string | false | none | none |
| messageParam30 | string | false | none | none |
| messageResult | integer(int32) | false | none | none |
| messageTemplate | string | false | none | none |
| messageToNumber | string | false | none | none |
DatamodelPowerDialerList
Properties
{
"__typename": "string",
"busy": {
"__typename": "string",
"attempts": 0,
"interval": 0
},
"cancel": {
"__typename": "string",
"attempts": 0,
"interval": 0
},
"congestion": {
"__typename": "string",
"attempts": 0,
"interval": 0
},
"id": 0,
"name": "string",
"noAnswer": {
"__typename": "string",
"attempts": 0,
"interval": 0
},
"tvoxClosed": {
"__typename": "string",
"attempts": 0,
"interval": 0
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| __typename | string | false | none | none |
| busy | DatamodelPowerDialingResultManagement | false | none | none |
| cancel | DatamodelPowerDialingResultManagement | false | none | none |
| congestion | DatamodelPowerDialingResultManagement | false | none | none |
| id | integer(int32) | false | none | none |
| name | string | false | none | none |
| noAnswer | DatamodelPowerDialingResultManagement | false | none | none |
| tvoxClosed | DatamodelPowerDialingResultManagement | false | none | none |
DatamodelPowerDialingResultManagement
Properties
{
"__typename": "string",
"attempts": 0,
"interval": 0
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| __typename | string | false | none | none |
| attempts | integer(int32) | false | none | none |
| interval | integer(int32) | false | none | none |
DatamodelSearchCallAbilitation
Properties
{
"description": {
"operator": "NULL",
"regexp": "string",
"value": [
"string"
]
},
"enabled": true,
"id": {
"operator": "NULL",
"value": [
0
]
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| description | DatamodelComparisonString | false | none | none |
| enabled | boolean | false | none | none |
| id | DatamodelComparisonNumber | false | none | none |
DatamodelSearchPowerDialerCampaign
Properties
{
"abilitation": {
"description": {
"operator": "NULL",
"regexp": "string",
"value": [
"string"
]
},
"enabled": true,
"id": {
"operator": "NULL",
"value": [
0
]
}
},
"enabled": true,
"id": {
"operator": "NULL",
"value": [
0
]
},
"list": {
"id": {
"operator": "NULL",
"value": [
0
]
},
"name": {
"operator": "NULL",
"regexp": "string",
"value": [
"string"
]
}
},
"name": {
"operator": "NULL",
"regexp": "string",
"value": [
"string"
]
},
"openFrom": {
"operator": "NULL",
"value": "string",
"valueLeft": "string",
"valueRight": "string"
},
"openTo": {
"operator": "NULL",
"value": "string",
"valueLeft": "string",
"valueRight": "string"
},
"priority": {
"operator": "NULL",
"value": [
0
]
},
"service": {
"code": {
"operator": "NULL",
"regexp": "string",
"value": [
"string"
]
},
"description": {
"operator": "NULL",
"regexp": "string",
"value": [
"string"
]
},
"serviceType": [
"IVR"
]
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| abilitation | DatamodelSearchCallAbilitation | false | none | none |
| enabled | boolean | false | none | none |
| id | DatamodelComparisonNumber | false | none | none |
| list | DatamodelSearchPowerDialerList | false | none | none |
| name | DatamodelComparisonString | false | none | none |
| openFrom | DatamodelComparisonTime | false | none | none |
| openTo | DatamodelComparisonTime | false | none | none |
| priority | DatamodelComparisonNumber | false | none | none |
| service | DatamodelSearchServiceDescription | false | none | none |
DatamodelSearchPowerDialerInstantMessagingCampaignStatus
Properties
{
"campaign": {
"abilitation": {
"description": {
"operator": "NULL",
"regexp": "string",
"value": [
"string"
]
},
"enabled": true,
"id": {
"operator": "NULL",
"value": [
0
]
}
},
"enabled": true,
"id": {
"operator": "NULL",
"value": [
0
]
},
"list": {
"id": {
"operator": "NULL",
"value": [
0
]
},
"name": {
"operator": "NULL",
"regexp": "string",
"value": [
"string"
]
}
},
"name": {
"operator": "NULL",
"regexp": "string",
"value": [
"string"
]
},
"openFrom": {
"operator": "NULL",
"value": "string",
"valueLeft": "string",
"valueRight": "string"
},
"openTo": {
"operator": "NULL",
"value": "string",
"valueLeft": "string",
"valueRight": "string"
},
"priority": {
"operator": "NULL",
"value": [
0
]
},
"service": {
"code": {
"operator": "NULL",
"regexp": "string",
"value": [
"string"
]
},
"description": {
"operator": "NULL",
"regexp": "string",
"value": [
"string"
]
},
"serviceType": [
"IVR"
]
}
},
"executionId": {
"operator": "NULL",
"value": [
0
]
},
"listId": {
"operator": "NULL",
"value": [
0
]
},
"month": 0,
"status": {
"operator": "NULL",
"regexp": "string",
"value": [
"string"
]
},
"year": 0
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| campaign | DatamodelSearchPowerDialerCampaign | false | none | none |
| executionId | DatamodelComparisonNumber | false | none | none |
| listId | DatamodelComparisonNumber | false | none | none |
| month | integer(int32) | false | none | none |
| status | DatamodelComparisonString | false | none | none |
| year | integer(int32) | false | none | none |
DatamodelSearchPowerDialerInstantMessagingHistory
Properties
{
"campaign": {
"abilitation": {
"description": {
"operator": "NULL",
"regexp": "string",
"value": [
"string"
]
},
"enabled": true,
"id": {
"operator": "NULL",
"value": [
0
]
}
},
"enabled": true,
"id": {
"operator": "NULL",
"value": [
0
]
},
"list": {
"id": {
"operator": "NULL",
"value": [
0
]
},
"name": {
"operator": "NULL",
"regexp": "string",
"value": [
"string"
]
}
},
"name": {
"operator": "NULL",
"regexp": "string",
"value": [
"string"
]
},
"openFrom": {
"operator": "NULL",
"value": "string",
"valueLeft": "string",
"valueRight": "string"
},
"openTo": {
"operator": "NULL",
"value": "string",
"valueLeft": "string",
"valueRight": "string"
},
"priority": {
"operator": "NULL",
"value": [
0
]
},
"service": {
"code": {
"operator": "NULL",
"regexp": "string",
"value": [
"string"
]
},
"description": {
"operator": "NULL",
"regexp": "string",
"value": [
"string"
]
},
"serviceType": [
"IVR"
]
}
},
"contactCustomId": {
"operator": "NULL",
"regexp": "string",
"value": [
"string"
]
},
"contactItem": {
"operator": "NULL",
"value": [
0
]
},
"contactUUID": {
"operator": "NULL",
"regexp": "string",
"value": [
"string"
]
},
"executionId": {
"operator": "NULL",
"value": [
0
]
},
"listId": {
"operator": "NULL",
"value": [
0
]
},
"messageCloseTime": {
"operator": "NULL",
"value": "string",
"valueLeft": "string",
"valueRight": "string"
},
"messageFromNumber": {
"operator": "NULL",
"regexp": "string",
"value": [
"string"
]
},
"messageId": {
"operator": "NULL",
"regexp": "string",
"value": [
"string"
]
},
"messageInsertTime": {
"operator": "NULL",
"value": "string",
"valueLeft": "string",
"valueRight": "string"
},
"messageResult": {
"operator": "NULL",
"value": [
0
]
},
"messageToNumber": {
"operator": "NULL",
"regexp": "string",
"value": [
"string"
]
},
"month": 0,
"year": 0
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| campaign | DatamodelSearchPowerDialerCampaign | false | none | none |
| contactCustomId | DatamodelComparisonString | false | none | none |
| contactItem | DatamodelComparisonNumber | false | none | none |
| contactUUID | DatamodelComparisonString | false | none | none |
| executionId | DatamodelComparisonNumber | false | none | none |
| listId | DatamodelComparisonNumber | false | none | none |
| messageCloseTime | DatamodelComparisonTime | false | none | none |
| messageFromNumber | DatamodelComparisonString | false | none | none |
| messageId | DatamodelComparisonString | false | none | none |
| messageInsertTime | DatamodelComparisonTime | false | none | none |
| messageResult | DatamodelComparisonNumber | false | none | none |
| messageToNumber | DatamodelComparisonString | false | none | none |
| month | integer(int32) | false | none | none |
| year | integer(int32) | false | none | none |
DatamodelSearchPowerDialerList
Properties
{
"id": {
"operator": "NULL",
"value": [
0
]
},
"name": {
"operator": "NULL",
"regexp": "string",
"value": [
"string"
]
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | DatamodelComparisonNumber | false | none | none |
| name | DatamodelComparisonString | false | none | none |
DatamodelSearchServiceDescription
Properties
{
"code": {
"operator": "NULL",
"regexp": "string",
"value": [
"string"
]
},
"description": {
"operator": "NULL",
"regexp": "string",
"value": [
"string"
]
},
"serviceType": [
"IVR"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| code | DatamodelComparisonString | false | none | none |
| description | DatamodelComparisonString | false | none | none |
| serviceType | [string] | false | none | none |
DatamodelServiceDescription
Properties
{
"__typename": "string",
"code": "string",
"description": "string"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| __typename | string | true | none | none |
| code | string | false | none | none |
| description | string | false | none | none |
DialNumberClientDisconnectedException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
]
}
None
DialNumberDeviceInUseRequiredException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
]
}
None
DialNumberGenericException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
]
}
None
DirectoryFields
Directory fields
Properties
{
"customCli": "string",
"customCliType": "CUST",
"customFields": {
"property1": "string",
"property2": "string"
},
"email": "string",
"fax": "string",
"homePhone": "string",
"mobilePhone": "string",
"otherPhone": "string"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| customCli | string | false | none | Custom CLI |
| customCliType | string | false | none | Custom CLI type |
| customFields | object | false | none | Custom fields |
| » additionalProperties | string | false | none | Custom fields |
| string | false | none | ||
| fax | string | false | none | Fax |
| homePhone | string | false | none | Home phone |
| mobilePhone | string | false | none | Mobile phone |
| otherPhone | string | false | none | Other phone |
Enumerated Values
| Property | Value |
|---|---|
| customCliType | CUST |
| customCliType | SERV |
DirectoryFieldsConfigurationPermission
Directory fields
Properties
{
"customFields": {
"property1": "DEFAULT",
"property2": "DEFAULT"
},
"email": "DEFAULT",
"fax": "DEFAULT",
"homePhone": "DEFAULT",
"mobilePhone": "DEFAULT",
"otherPhone": "DEFAULT",
"permission": "DEFAULT"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| customFields | object | false | none | none |
| » additionalProperties | string | false | none | none |
| string | false | none | none | |
| fax | string | false | none | none |
| homePhone | string | false | none | none |
| mobilePhone | string | false | none | none |
| otherPhone | string | false | none | none |
| permission | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| additionalProperties | DEFAULT |
| additionalProperties | NONE |
| additionalProperties | READ |
| additionalProperties | READ_WRITE |
| additionalProperties | READ_ADD |
| additionalProperties | READ_WRITE_ADD |
| DEFAULT | |
| NONE | |
| READ | |
| READ_WRITE | |
| READ_ADD | |
| READ_WRITE_ADD | |
| fax | DEFAULT |
| fax | NONE |
| fax | READ |
| fax | READ_WRITE |
| fax | READ_ADD |
| fax | READ_WRITE_ADD |
| homePhone | DEFAULT |
| homePhone | NONE |
| homePhone | READ |
| homePhone | READ_WRITE |
| homePhone | READ_ADD |
| homePhone | READ_WRITE_ADD |
| mobilePhone | DEFAULT |
| mobilePhone | NONE |
| mobilePhone | READ |
| mobilePhone | READ_WRITE |
| mobilePhone | READ_ADD |
| mobilePhone | READ_WRITE_ADD |
| otherPhone | DEFAULT |
| otherPhone | NONE |
| otherPhone | READ |
| otherPhone | READ_WRITE |
| otherPhone | READ_ADD |
| otherPhone | READ_WRITE_ADD |
| permission | DEFAULT |
| permission | NONE |
| permission | READ |
| permission | READ_WRITE |
| permission | READ_ADD |
| permission | READ_WRITE_ADD |
Exten
Exten
Properties
{
"dtoStatus": "DELETED",
"exten": "string",
"host": "string",
"ownerPanels": [
"string"
],
"status": "UNKNOWN",
"type": "MCS_SIP",
"userAgent": "string"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| dtoStatus | string | false | none | none |
| exten | string | false | none | Exten |
| host | string | false | none | Host |
| ownerPanels | [string] | false | none | none |
| status | string | false | none | Status |
| type | string | false | none | Type |
| userAgent | string | false | none | User Agent |
Enumerated Values
| Property | Value |
|---|---|
| dtoStatus | DELETED |
| dtoStatus | NEW |
| dtoStatus | MODIFIED |
| status | UNKNOWN |
| status | UNREGISTERED |
| status | LAGGED |
| status | UNMONITORED |
| status | UNREACHABLE |
| status | REGISTERED |
| status | REACHABLE |
| type | MCS_SIP |
| type | MCS_APP |
| type | MCS_APP_WEBRTC |
| type | SIP |
| type | EXTERNAL |
| type | WEBRTC |
ExtenExternal
Exten external
Properties
{
"dtoStatus": "DELETED",
"exten": "string",
"host": "string",
"ownerPanels": [
"string"
],
"status": "UNKNOWN",
"type": "MCS_SIP",
"userAgent": "string"
}
None
ExtenLabel
Exten label
Properties
{
"id": "string",
"img": "string",
"name": "string",
"position": 0,
"values": {
"property1": "string",
"property2": "string"
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | false | none | Id |
| img | string | false | none | Image |
| name | string | false | none | Name |
| position | integer(int32) | false | none | Position |
| values | object | false | none | Values |
| » additionalProperties | string | false | none | Values |
ExtenMCSApp
Exten MCS APP
Properties
{
"dtoStatus": "DELETED",
"exten": "string",
"host": "string",
"ownerPanels": [
"string"
],
"status": "UNKNOWN",
"type": "MCS_SIP",
"userAgent": "string",
"clidToPstnList": [
"string"
]
}
allOf - discriminator: Exten.type
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | Exten | false | none | Exten |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » clidToPstnList | [string] | false | none | CLID to PSTN list |
ExtenMCSAppWebRTC
Exten MCS APP WebRTC
Properties
{
"dtoStatus": "DELETED",
"exten": "string",
"host": "string",
"ownerPanels": [
"string"
],
"status": "UNKNOWN",
"type": "MCS_SIP",
"userAgent": "string",
"callbackGsmValue": {
"defaultValue": "ENABLED",
"enableDefault": true,
"value": "ENABLED"
},
"fallbackGsmValue": {
"defaultValue": "ENABLED",
"enableDefault": true,
"value": "ENABLED"
},
"mcsEnable": true,
"mediaAudio": true,
"mediaDesktop": true,
"mediaVideo": true
}
allOf - discriminator: Exten.type
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | Exten | false | none | Exten |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » callbackGsmValue | ValueEnabled | false | none | DND notify value |
| » fallbackGsmValue | ValueEnabled | false | none | DND notify value |
| » mcsEnable | boolean | false | none | MCS enabled |
| » mediaAudio | boolean | false | none | Media audio enabled |
| » mediaDesktop | boolean | false | none | Media desktop enabled |
| » mediaVideo | boolean | false | none | Media video enabled |
ExtenSIP
Exten SIP
Properties
{
"dtoStatus": "DELETED",
"exten": "string",
"host": "string",
"ownerPanels": [
"string"
],
"status": "UNKNOWN",
"type": "MCS_SIP",
"userAgent": "string",
"mac": "string",
"model": "string",
"modelName": "string",
"nameAssignedExten": "string",
"nameUsedExten": "string",
"secondaryExtenForUser": true,
"secret": "string",
"surnameAssignedExten": "string",
"surnameUsedExten": "string",
"usernameAssignedExten": "string",
"usernameUsedExten": "string",
"vendor": "string"
}
allOf - discriminator: Exten.type
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | Exten | false | none | Exten |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » mac | string | false | none | MAC address |
| » model | string | false | none | Model |
| » modelName | string | false | none | Model name |
| » nameAssignedExten | string | false | none | Name assigned exten |
| » nameUsedExten | string | false | none | Name used exten |
| » secondaryExtenForUser | boolean | false | none | Secondary exten for user |
| » secret | string | false | none | Secret |
| » surnameAssignedExten | string | false | none | Surname assigned exten |
| » surnameUsedExten | string | false | none | Surname used exten |
| » usernameAssignedExten | string | false | none | User id assigned exten |
| » usernameUsedExten | string | false | none | User id used exten |
| » vendor | string | false | none | Vendor |
ExtenWebRTC
Exten WebRTC
Properties
{
"dtoStatus": "DELETED",
"exten": "string",
"host": "string",
"ownerPanels": [
"string"
],
"status": "UNKNOWN",
"type": "MCS_SIP",
"userAgent": "string",
"mcsEnable": true,
"mediaAudio": true,
"mediaDesktop": true,
"mediaVideo": true
}
allOf - discriminator: Exten.type
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | Exten | false | none | Exten |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » mcsEnable | boolean | false | none | MCS enabled |
| » mediaAudio | boolean | false | none | Media audio enabled |
| » mediaDesktop | boolean | false | none | Media desktop enabled |
| » mediaVideo | boolean | false | none | Media video enabled |
FTPServerCreateDirectoryErrorException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
]
}
None
FTPServerDeleteFileErrorException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
]
}
None
FTPServerGetFileErrorException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
]
}
None
FTPServerRetrieveFileErrorException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
]
}
None
FTPServerUnavailableException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
]
}
None
FTPServerUploadFileErrorException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
]
}
None
FaxBox
Fax Box
Properties
{
"identifier": 0,
"name": "string"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| identifier | integer(int32) | false | none | none |
| name | string | false | none | none |
FaxBoxUser
Fax Box for user
Properties
{
"administrator": true,
"fax": {
"identifier": 0,
"name": "string"
},
"receiving": "MAIL",
"receivingEnabled": true,
"sending": "MAIL",
"sendingEnabled": true
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| administrator | boolean | false | none | Administrator |
| fax | FaxBox | false | none | Fax Box |
| receiving | string | false | none | Receiving notification mode |
| receivingEnabled | boolean | false | none | Receiving enabled |
| sending | string | false | none | Sending notification mode |
| sendingEnabled | boolean | false | none | Sending enabled |
Enumerated Values
| Property | Value |
|---|---|
| receiving | |
| receiving | SMS |
| sending | |
| sending | SMS |
FeedbackClientUserSettings
Feedback client user settings
Properties
{
"maxAttachmentsSizeValue": {
"defaultValue": 0,
"enableDefault": true,
"value": 0
},
"sendFeedbackEnabledValue": {
"defaultValue": true,
"enableDefault": true,
"value": true
},
"webClientLogMinutesValue": {
"defaultValue": 0,
"enableDefault": true,
"value": 0
},
"webClientLogValue": {
"defaultValue": true,
"enableDefault": true,
"value": true
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| maxAttachmentsSizeValue | ValueInteger | false | none | WebClient log minutes value |
| sendFeedbackEnabledValue | ValueBoolean | false | none | WebClient log value |
| webClientLogMinutesValue | ValueInteger | false | none | WebClient log minutes value |
| webClientLogValue | ValueBoolean | false | none | WebClient log value |
FileUpload
Attachments
Properties
{
"mimeType": "string",
"name": "string",
"uuid": "string"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| mimeType | string | false | none | none |
| name | string | false | none | none |
| uuid | string | false | none | none |
Filter
Properties
{
"descrizione": "string",
"id": 0
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| descrizione | string | false | none | none |
| id | integer(int32) | false | none | none |
ForbiddenException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
]
}
None
FunctionAction
Properties
"HELP"
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | HELP |
| anonymous | RUBINT |
| anonymous | RUBEST |
| anonymous | RUBGLOB |
| anonymous | PO |
| anonymous | PARK |
| anonymous | DTMF |
| anonymous | BNOTES |
| anonymous | TQM |
| anonymous | POSTIT |
| anonymous | RICALT |
| anonymous | INVIOCH |
Generic
Properties
{
"className": "string",
"field": "string",
"value": {}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| className | string | false | none | none |
| field | string | false | none | none |
| value | object | false | none | none |
GenericFile
Properties
{
"body": "string",
"name": "string",
"size": 0,
"type": "string"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| body | string | false | none | none |
| name | string | false | none | none |
| size | integer(int64) | false | none | none |
| type | string | false | none | none |
GenericHibernateException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"exception": {
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{}
],
"suppressed": [
{}
]
},
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
}
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » exception | object | false | none | none |
| »» cause | object | false | none | none |
| »»» localizedMessage | string | false | none | none |
| »»» message | string | false | none | none |
| »»» stackTrace | [object] | false | none | none |
| »»»» className | string | false | none | none |
| »»»» fileName | string | false | none | none |
| »»»» lineNumber | integer(int32) | false | none | none |
| »»»» methodName | string | false | none | none |
| »»»» nativeMethod | boolean | false | none | none |
| »»» suppressed | [object] | false | none | none |
| »»»» localizedMessage | string | false | none | none |
| »»»» message | string | false | none | none |
| »»»» stackTrace | [object] | false | none | none |
| »»»»» className | string | false | none | none |
| »»»»» fileName | string | false | none | none |
| »»»»» lineNumber | integer(int32) | false | none | none |
| »»»»» methodName | string | false | none | none |
| »»»»» nativeMethod | boolean | false | none | none |
| »» localizedMessage | string | false | none | none |
| »» message | string | false | none | none |
| »» stackTrace | [object] | false | none | none |
| »»» className | string | false | none | none |
| »»» fileName | string | false | none | none |
| »»» lineNumber | integer(int32) | false | none | none |
| »»» methodName | string | false | none | none |
| »»» nativeMethod | boolean | false | none | none |
| »» suppressed | [object] | false | none | none |
| »»» localizedMessage | string | false | none | none |
| »»» message | string | false | none | none |
| »»» stackTrace | [object] | false | none | none |
| »»»» className | string | false | none | none |
| »»»» fileName | string | false | none | none |
| »»»» lineNumber | integer(int32) | false | none | none |
| »»»» methodName | string | false | none | none |
| »»»» nativeMethod | boolean | false | none | none |
GenericObjectException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"className": "string",
"field": "string",
"value": {}
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » className | string | false | none | none |
| » field | string | false | none | none |
| » value | object | false | none | none |
GenericObjectExistsException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"className": "string",
"field": "string",
"value": {}
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » className | string | false | none | none |
| » field | string | false | none | none |
| » value | object | false | none | none |
GenericObjectFormatException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"className": "string",
"field": "string",
"value": {}
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » className | string | false | none | none |
| » field | string | false | none | none |
| » value | object | false | none | none |
GenericObjectIsDuplicatedException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"className": "string",
"field": "string",
"value": {}
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » className | string | false | none | none |
| » field | string | false | none | none |
| » value | object | false | none | none |
GenericObjectIsInUseException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"className": "string",
"field": "string",
"users": [
{
"description": "string",
"id": "string",
"type": "MOH"
}
],
"value": {}
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » className | string | false | none | none |
| » field | string | false | none | none |
| » users | [UserOfGeneric] | false | none | none |
| » value | object | false | none | none |
GenericObjectMaxDateException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"className": "string",
"field": "string",
"maxDate": "2019-08-24T14:15:22Z",
"maxValue": "2019-08-24T14:15:22Z",
"minDate": "2019-08-24T14:15:22Z",
"minValue": "2019-08-24T14:15:22Z",
"value": {}
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » className | string | false | none | none |
| » field | string | false | none | none |
| » maxDate | string(date-time) | false | none | none |
| » maxValue | string(date-time) | false | write-only | none |
| » minDate | string(date-time) | false | none | none |
| » minValue | string(date-time) | false | write-only | none |
| » value | object | false | none | none |
GenericObjectMaxSizeException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"className": "string",
"field": "string",
"maxSize": 0,
"value": {}
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » className | string | false | none | none |
| » field | string | false | none | none |
| » maxSize | integer(int32) | false | none | none |
| » value | object | false | none | none |
GenericObjectMaxValueException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"className": "string",
"field": "string",
"maxValue": {},
"minValue": {},
"value": {}
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » className | string | false | none | none |
| » field | string | false | none | none |
| » maxValue | object | false | none | none |
| » minValue | object | false | none | none |
| » value | object | false | none | none |
GenericObjectMinDateException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"className": "string",
"field": "string",
"maxDate": "2019-08-24T14:15:22Z",
"maxValue": "2019-08-24T14:15:22Z",
"minDate": "2019-08-24T14:15:22Z",
"minValue": "2019-08-24T14:15:22Z",
"value": {}
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » className | string | false | none | none |
| » field | string | false | none | none |
| » maxDate | string(date-time) | false | none | none |
| » maxValue | string(date-time) | false | write-only | none |
| » minDate | string(date-time) | false | none | none |
| » minValue | string(date-time) | false | write-only | none |
| » value | object | false | none | none |
GenericObjectMinSizeException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"className": "string",
"field": "string",
"minSize": 0,
"value": {}
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » className | string | false | none | none |
| » field | string | false | none | none |
| » minSize | integer(int32) | false | none | none |
| » value | object | false | none | none |
GenericObjectMinValueException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"className": "string",
"field": "string",
"maxValue": {},
"minValue": {},
"value": {}
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » className | string | false | none | none |
| » field | string | false | none | none |
| » maxValue | object | false | none | none |
| » minValue | object | false | none | none |
| » value | object | false | none | none |
GenericObjectRangeDateException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"className": "string",
"field": "string",
"maxDate": "2019-08-24T14:15:22Z",
"maxValue": "2019-08-24T14:15:22Z",
"minDate": "2019-08-24T14:15:22Z",
"minValue": "2019-08-24T14:15:22Z",
"value": {}
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » className | string | false | none | none |
| » field | string | false | none | none |
| » maxDate | string(date-time) | false | none | none |
| » maxValue | string(date-time) | false | write-only | none |
| » minDate | string(date-time) | false | none | none |
| » minValue | string(date-time) | false | write-only | none |
| » value | object | false | none | none |
GenericObjectRangeValueException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"className": "string",
"field": "string",
"maxValue": {},
"minValue": {},
"value": {}
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » className | string | false | none | none |
| » field | string | false | none | none |
| » maxValue | object | false | none | none |
| » minValue | object | false | none | none |
| » value | object | false | none | none |
GenericObjectRequiredDigitValueException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"className": "string",
"field": "string",
"value": {}
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » className | string | false | none | none |
| » field | string | false | none | none |
| » value | object | false | none | none |
GenericObjectRequiredException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"className": "string",
"field": "string",
"mandatoryFields": [
{
"className": "string",
"field": "string",
"value": {}
}
],
"value": {}
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » className | string | false | none | none |
| » field | string | false | none | none |
| » mandatoryFields | [Generic] | false | none | none |
| » value | object | false | none | none |
GenericObjectRequiredNumberValueException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"className": "string",
"field": "string",
"value": {}
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » className | string | false | none | none |
| » field | string | false | none | none |
| » value | object | false | none | none |
GenericObjectSameSizeException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"className": "string",
"field": "string",
"maxSize": 0,
"value": {}
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » className | string | false | none | none |
| » field | string | false | none | none |
| » maxSize | integer(int32) | false | none | none |
| » value | object | false | none | none |
GenericObjectSystemValueException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"className": "string",
"field": "string",
"value": {}
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » className | string | false | none | none |
| » field | string | false | none | none |
| » value | object | false | none | none |
GenericObjectUnchangeableException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"className": "string",
"field": "string",
"value": {}
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » className | string | false | none | none |
| » field | string | false | none | none |
| » value | object | false | none | none |
GenericObjectWasNotFoundException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"className": "string",
"field": "string",
"value": {}
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » className | string | false | none | none |
| » field | string | false | none | none |
| » value | object | false | none | none |
GenericUploadFileErrorException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
]
}
None
GroupCC
Properties
{
"callStrategy": "RING_ALL_READY",
"descrizione": "string",
"logoutReasonList": {
"codes": [
{
"code": "string",
"list": "string",
"value": "string"
}
],
"description": "string",
"id": "string"
},
"nrTransitionLimit": 0,
"nrTransitionSupervised": true,
"scheduledLoggedProfile": true,
"site": {
"confStatus": "ON",
"domainReachable": "string",
"dtoStatus": "DELETED",
"id": "string",
"name": "string",
"ownerPanels": [
"string"
],
"pbxStatus": "ON",
"trunk": {
"dtoStatus": "DELETED",
"host": "string",
"name": "string",
"ownerPanels": [
"string"
],
"status": "UNKNOWN",
"type": "SIP"
}
},
"skillset": "string",
"timeZone": "string",
"type": "CALLCENTER"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| callStrategy | string | false | none | none |
| descrizione | string | false | none | none |
| logoutReasonList | LogoutReasonList | false | none | none |
| nrTransitionLimit | integer(int32) | false | none | none |
| nrTransitionSupervised | boolean | false | none | none |
| scheduledLoggedProfile | boolean | false | none | none |
| site | NCCSite | false | none | none |
| skillset | string | false | none | none |
| timeZone | string | false | none | none |
| type | SkillsetType | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| callStrategy | RING_ALL_READY |
| callStrategy | RING_ALL_LOGGED |
| callStrategy | ID_CALL |
| callStrategy | IDLE |
| callStrategy | PLANNED |
GroupHG
Properties
{
"callStrategy": "RING_ALL",
"descrizione": "string",
"skillset": "string",
"type": "CALLCENTER"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| callStrategy | string | false | none | none |
| descrizione | string | false | none | none |
| skillset | string | false | none | none |
| type | SkillsetType | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| callStrategy | RING_ALL |
| callStrategy | HUNT |
| callStrategy | ID_CALL_UC |
| callStrategy | RING_ALL_CONFERENCE |
| callStrategy | RING_ALL_CONFERENCE_AUTOANSWER |
| callStrategy | DIR_SEG |
| callStrategy | ASS_SEG |
| callStrategy | DIR_SEG_XOR |
GroupHGAssSeg
Properties
{
"callStrategy": "RING_ALL",
"descrizione": "string",
"skillset": "string",
"type": "CALLCENTER"
}
None
GroupHGDirExclusive
Properties
{
"callStrategy": "RING_ALL",
"descrizione": "string",
"skillset": "string",
"type": "CALLCENTER"
}
None
GroupHGDirSeg
Properties
{
"callStrategy": "RING_ALL",
"descrizione": "string",
"skillset": "string",
"type": "CALLCENTER"
}
None
GroupHGHunt
Properties
{
"callStrategy": "RING_ALL",
"descrizione": "string",
"skillset": "string",
"type": "CALLCENTER"
}
None
GroupHGIdCallUc
Properties
{
"callStrategy": "RING_ALL",
"descrizione": "string",
"skillset": "string",
"type": "CALLCENTER"
}
None
GroupHGRingAll
Properties
{
"callStrategy": "RING_ALL",
"descrizione": "string",
"skillset": "string",
"type": "CALLCENTER"
}
None
GroupHGRingAllConference
Properties
{
"callStrategy": "RING_ALL",
"descrizione": "string",
"skillset": "string",
"type": "CALLCENTER"
}
None
GroupHGRingAllConferenceAutoanswer
Properties
{
"callStrategy": "RING_ALL",
"descrizione": "string",
"skillset": "string",
"type": "CALLCENTER"
}
None
GroupTQM
Properties
{
"callStrategy": "RING_ALL_READY",
"descrizione": "string",
"skillset": "string",
"type": "CALLCENTER"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| callStrategy | string | false | none | none |
| descrizione | string | false | none | none |
| skillset | string | false | none | none |
| type | SkillsetType | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| callStrategy | RING_ALL_READY |
| callStrategy | RING_ALL_LOGGED |
| callStrategy | ID_CALL |
| callStrategy | IDLE |
ImportedUser
Properties
{
"index": 0,
"username": "string"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| index | integer(int32) | false | none | none |
| username | string | false | none | none |
InboundRoute
Inbound route
Properties
{
"bpmId": 0,
"calledNumber": "string",
"calledNumberRegExp": true,
"callerNumber": "string",
"callerNumberRegExp": true,
"description": "string",
"disaEnable": true,
"disaRetry": 0,
"followCalendar": "ENABLED",
"id": 0,
"name": "string",
"serviceType": "IVR",
"type": "USER",
"value": "string"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| bpmId | integer(int32) | false | none | BPM id |
| calledNumber | string | false | none | Called number |
| calledNumberRegExp | boolean | false | none | Called number regular expression |
| callerNumber | string | false | none | Caller number |
| callerNumberRegExp | boolean | false | none | none |
| description | string | false | none | Description |
| disaEnable | boolean | false | none | Disa enabled |
| disaRetry | integer(int32) | false | none | Disa retry |
| followCalendar | string | false | none | Follow calendar enabled |
| id | integer(int32) | false | none | Id |
| name | string | false | none | Name |
| serviceType | ServiceType | false | none | Service type |
| type | string | false | none | Type |
| value | string | false | none | Value |
Enumerated Values
| Property | Value |
|---|---|
| followCalendar | ENABLED |
| followCalendar | DISABLED |
| followCalendar | DEFAULT |
| type | USER |
| type | FAX |
| type | SERVICE |
| type | SERVICE_CODE |
| type | NUMBER |
| type | CONFERENCEROOM |
| type | HANGUP |
| type | BUSY |
| type | CONGESTION |
InternalServerErrorException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
]
}
None
InvalidActionException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"className": "string",
"field": "string",
"value": {}
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » className | string | false | none | none |
| » field | string | false | none | none |
| » value | object | false | none | none |
InvalidArgumentException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"className": "string",
"field": "string",
"value": {}
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » className | string | false | none | none |
| » field | string | false | none | none |
| » value | object | false | none | none |
InvalidLicenceException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
]
}
None
InvalidOldPasswordException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"className": "string",
"field": "string",
"value": {}
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » className | string | false | none | none |
| » field | string | false | none | none |
| » value | object | false | none | none |
InvalidPasswordException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"className": "string",
"field": "string",
"value": {}
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » className | string | false | none | none |
| » field | string | false | none | none |
| » value | object | false | none | none |
InvalidPasswordSecureException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"className": "string",
"field": "string",
"messages": [
"string"
],
"value": {}
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » className | string | false | none | none |
| » field | string | false | none | none |
| » messages | [string] | false | none | none |
| » value | object | false | none | none |
KeyToAction
Properties
{
"f10Action": "HELP",
"f11Action": "HELP",
"f12Action": "HELP",
"f1Action": "HELP",
"f2Action": "HELP",
"f3Action": "HELP",
"f4Action": "HELP",
"f5Action": "HELP",
"f6Action": "HELP",
"f7Action": "HELP",
"f8Action": "HELP",
"f9Action": "HELP"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| f10Action | FunctionAction | false | none | none |
| f11Action | FunctionAction | false | none | none |
| f12Action | FunctionAction | false | none | none |
| f1Action | FunctionAction | false | none | none |
| f2Action | FunctionAction | false | none | none |
| f3Action | FunctionAction | false | none | none |
| f4Action | FunctionAction | false | none | none |
| f5Action | FunctionAction | false | none | none |
| f6Action | FunctionAction | false | none | none |
| f7Action | FunctionAction | false | none | none |
| f8Action | FunctionAction | false | none | none |
| f9Action | FunctionAction | false | none | none |
Language
Language
Properties
"IT"
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | Language |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | IT |
| anonymous | it_IT |
| anonymous | EN |
| anonymous | en_US |
| anonymous | FR |
| anonymous | fr_FR |
| anonymous | NL |
| anonymous | nl_NL |
LicenceExceededException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"module": "ABBANDONED_CALL"
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » module | LicenseModule | false | none | none |
LicenceNotFoundException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"module": "ABBANDONED_CALL"
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » module | LicenseModule | false | none | none |
LicenseModule
Properties
"ABBANDONED_CALL"
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | ABBANDONED_CALL |
| anonymous | ABOT |
| anonymous | AGENT |
| anonymous | AGENT_CLIENT |
| anonymous | AGENT_MULTICHANNEL_1 |
| anonymous | AGENT_MULTICHANNEL_2 |
| anonymous | AGENT_MULTICHANNEL_3 |
| anonymous | AGENT_MULTICHANNEL_CALLBACK |
| anonymous | AGENT_MULTICHANNEL_CHAT |
| anonymous | AGENT_MULTICHANNEL_LIVEHELP |
| anonymous | AGENT_MULTICHANNEL_MAIL |
| anonymous | AGENT_MULTICHANNEL_VIDEO |
| anonymous | AGENT_MULTICHANNEL_WHATSAPP_TWILIO |
| anonymous | AGENT_MULTICHANNEL_OMNIDESK |
| anonymous | AGENT_PICKUP_SERVICE |
| anonymous | APP_USERS |
| anonymous | ASSET |
| anonymous | AVAIL |
| anonymous | BPMN_ADVANCED_VIRTUAL_AGENT_TELEPHONE |
| anonymous | BPMN_VIRTUAL_AGENT_TELEPHONE |
| anonymous | BPMN_VIRTUAL_AGENT_CHAT |
| anonymous | BLF_SIP |
| anonymous | BLF_SKYPE |
| anonymous | BRANCH_OFFICE |
| anonymous | BRANCH_OFFICE_CLIENT |
| anonymous | CAC |
| anonymous | CALLBACK |
| anonymous | CALLBACK_POWERDIALER |
| anonymous | CAMPAIGN_IM |
| anonymous | CAMPAIGN_SMS |
| anonymous | CAMPAIGN_MAIL |
| anonymous | CDR |
| anonymous | CUSTOMER |
| anonymous | CUSTOMER_JOURNEY |
| anonymous | CUSTOMER_JOURNEY_SERVER |
| anonymous | DISASTER_RECOVERY |
| anonymous | DISASTER_RECOVERY_CLIENT |
| anonymous | DLLREC |
| anonymous | ES_SERVER |
| anonymous | EXTERNAL_ADDRESSBOOK |
| anonymous | FAULT_TOLERANCE |
| anonymous | FAX_SERVER |
| anonymous | GRTD |
| anonymous | IDM |
| anonymous | INSIGHT |
| anonymous | KB_SERVER |
| anonymous | KB_USER |
| anonymous | LDAP_EXPORT_USERS |
| anonymous | MCS |
| anonymous | MCS_APP_USERS |
| anonymous | MCS_APP_WEBRTC |
| anonymous | MCS_USERS |
| anonymous | MCS_CERT |
| anonymous | MC_TICKET_SERVER |
| anonymous | MOBILITY |
| anonymous | MRCP |
| anonymous | MRCP_RM |
| anonymous | MSOP |
| anonymous | MULTICHANNEL_1 |
| anonymous | MULTICHANNEL_2 |
| anonymous | MULTICHANNEL_3 |
| anonymous | MULTICHANNEL_CALLBACK |
| anonymous | MULTICHANNEL_CHAT |
| anonymous | MULTICHANNEL_LIVEHELP |
| anonymous | MULTICHANNEL_MAIL |
| anonymous | MULTICHANNEL_VIDEO |
| anonymous | MULTICHANNEL_WHATSAPP_TWILIO |
| anonymous | MULTICHANNEL_OMNIDESK |
| anonymous | OMNIDESK |
| anonymous | OPERATOR |
| anonymous | OPERATOR_PICKUP_SERVICE |
| anonymous | OTRS |
| anonymous | POWER_DIALER |
| anonymous | PROVISIONING |
| anonymous | PURE_CLOUD |
| anonymous | QUALITY_INTERVIEW |
| anonymous | QUALITY_INTERVIEW_AUTO |
| anonymous | QUEUE |
| anonymous | SCALE |
| anonymous | SEDE |
| anonymous | SKT_SCHEDULE |
| anonymous | SMARTREC |
| anonymous | SMARTREC_AUTO |
| anonymous | SMS |
| anonymous | SNMP_FWD |
| anonymous | SOFTPHONE |
| anonymous | T4YOU |
| anonymous | T4YOU_CENTRALIZED |
| anonymous | T4YOU_CUSTOM |
| anonymous | T4YOU_EXCHANGE |
| anonymous | T4YOU_FILEXMLCSV |
| anonymous | T4YOU_GOOGLE |
| anonymous | T4YOU_LDAP |
| anonymous | T4YOU_MYSQL |
| anonymous | T4YOU_ORACLE |
| anonymous | T4YOU_SOAP |
| anonymous | T4YOU_SQLSERVER |
| anonymous | T4YOU_SUITECRM |
| anonymous | T4YOU_VTE |
| anonymous | T4YOU_ZIMBRA |
| anonymous | T4YOU_MICROSOFT365 |
| anonymous | TADS |
| anonymous | TCC_EXTERNAL |
| anonymous | TUC_REMOTE |
| anonymous | TCC_REMOTE |
| anonymous | TEMP |
| anonymous | TICKET |
| anonymous | TLS |
| anonymous | TSAM |
| anonymous | TSAM_ACCOUNTING |
| anonymous | TSAM_MONITORING |
| anonymous | TSAM_TICKET |
| anonymous | TTS |
| anonymous | TTS_PROMPT |
| anonymous | TVOX |
| anonymous | TVOX_SERVICE_OUTBOUND |
| anonymous | TWIN |
| anonymous | USER |
| anonymous | USER_ACD |
| anonymous | USER_ACD_CLIENT |
| anonymous | USER_CLIENT |
| anonymous | USER_SUPPORT_LIGHT |
| anonymous | VIP |
| anonymous | VIP_ACD |
| anonymous | WAC_IPO |
| anonymous | WAC_SV |
| anonymous | WAC_BB |
| anonymous | WEBRTC |
| anonymous | VA_TEL |
| anonymous | VA_CHAT |
| anonymous | VA_ADVANCED_TEL |
LoginByAccessTokenRequest
Login with access token request
Properties
{
"accessToken": "string",
"version": "string"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| accessToken | string | true | none | Access Token |
| version | string | true | none | API version |
LoginProfile
Logged user profile
Properties
{
"accessToken": "string",
"anonymous": true,
"chatAuthToken": "string",
"chatUri": "string",
"chatUserId": "string",
"customProperties": {
"property1": {},
"property2": {}
},
"isCloudPlatform": true,
"language": "IT",
"logged": true,
"name": "string",
"profileRoles": [
"string"
],
"publicUsername": "string",
"pwdChangeable": true,
"sessionId": "string",
"status": "UNKNOWN",
"supportAuthToken": "string",
"surname": "string",
"userPermissions": [
"SUPERUSER"
],
"username": "string"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| accessToken | string | true | none | Access Token |
| anonymous | boolean | true | none | Anonymous user |
| chatAuthToken | string | false | none | Chat auth token |
| chatUri | string | false | none | Chat URI |
| chatUserId | string | false | none | Chat user ID |
| customProperties | object | false | none | Custom properties |
| » additionalProperties | object | false | none | Custom properties |
| isCloudPlatform | boolean | false | none | Is a cloud platform or a classic installation |
| language | Language | false | none | Language |
| logged | boolean | true | none | Logged |
| name | string | false | none | none |
| profileRoles | [string] | false | none | User roles |
| publicUsername | string | true | none | Username |
| pwdChangeable | boolean | true | none | Password changeable |
| sessionId | string | true | none | Session ID |
| status | string | true | none | Login status |
| supportAuthToken | string | false | none | Support auth token |
| surname | string | false | none | none |
| userPermissions | [UserPermission] | false | none | User permissions |
| username | string | true | none | User id |
Enumerated Values
| Property | Value |
|---|---|
| status | UNKNOWN |
| status | LOGGED |
| status | NOTLOGGED |
| status | RETRY |
| status | REFRESH |
| status | SOCKET_NOTLOGGED |
| status | PASSWORD_EXPIRED |
| status | SOCKET_CLOSED_REQUEST_FORCE |
| status | SOCKET_CLOSED_BY_USER |
| status | SOCKET_CLOSED_USER_NOT_ENABLED |
| status | SOCKET_CLOSED_USER_NOT_ENABLED_MCS |
LoginRequest
Login with credentials request
Properties
{
"password": "string",
"username": "string",
"version": "string"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| password | string | true | none | Password |
| username | string | true | none | User id |
| version | string | true | none | API version |
LoginWrongMasterVersionException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"sessionId": "string",
"versionRequired": "string"
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » sessionId | string | false | none | none |
| » versionRequired | string | false | none | none |
LogoutNotAllowedCauseLoggedInCalendarSchedule
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"className": "string",
"field": "string",
"skillsetsWithCalendarSchedule": [
"string"
],
"value": {}
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » className | string | false | none | none |
| » field | string | false | none | none |
| » skillsetsWithCalendarSchedule | [string] | false | none | none |
| » value | object | false | none | none |
LogoutProcedure
Properties
{
"errno": 0,
"error": "string",
"exten_removed": [
{
"dtoStatus": "DELETED",
"exten": "string",
"host": "string",
"ownerPanels": [
"string"
],
"status": "UNKNOWN",
"type": "MCS_SIP",
"userAgent": "string"
}
],
"profile_added": 0,
"profile_removed": 0,
"result": "RESULT_OK"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| errno | integer(int32) | false | none | none |
| error | string | false | none | none |
| exten_removed | [Exten] | false | none | [Exten] |
| profile_added | integer(int32) | false | none | none |
| profile_removed | integer(int32) | false | none | none |
| result | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| result | RESULT_OK |
| result | E_WRONG_PARAMETERS |
| result | E_DATABASE_ERROR |
| result | E_LICENSE_EXCEEDED |
| result | E_LICENSE_NOT_PRESENT |
| result | E_EXTENSION_IS_UNKNOWN |
| result | E_EXTENSION_IN_USE |
| result | E_USERNAME_IS_UNKNOWN |
| result | E_USERNAME_IS_NOTLOGGED |
| result | E_USERNAME_IS_LOGGED |
| result | E_ASTERISK_ERROR |
| result | E_USERNAME_LOGGED_IN_BY_SCHEDULE |
| result | E_UNKNOWN |
LogoutReason
Properties
{
"code": "string",
"list": "string",
"value": "string"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| code | string | false | none | none |
| list | string | false | none | none |
| value | string | false | none | none |
LogoutReasonList
Properties
{
"codes": [
{
"code": "string",
"list": "string",
"value": "string"
}
],
"description": "string",
"id": "string"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| codes | [LogoutReason] | false | none | none |
| description | string | false | none | none |
| id | string | false | none | none |
LogoutUserException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
]
},
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"result": {
"errno": 0,
"error": "string",
"exten_removed": [
{
"dtoStatus": "DELETED",
"exten": "string",
"host": "string",
"ownerPanels": [
"string"
],
"status": "UNKNOWN",
"type": "MCS_SIP",
"userAgent": "string"
}
],
"profile_added": 0,
"profile_removed": 0,
"result": "RESULT_OK"
},
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
]
}
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| cause | object | false | none | none |
| » localizedMessage | string | false | none | none |
| » message | string | false | none | none |
| » stackTrace | [object] | false | none | none |
| »» className | string | false | none | none |
| »» fileName | string | false | none | none |
| »» lineNumber | integer(int32) | false | none | none |
| »» methodName | string | false | none | none |
| »» nativeMethod | boolean | false | none | none |
| » suppressed | [object] | false | none | none |
| »» localizedMessage | string | false | none | none |
| »» message | string | false | none | none |
| »» stackTrace | [object] | false | none | none |
| »»» className | string | false | none | none |
| »»» fileName | string | false | none | none |
| »»» lineNumber | integer(int32) | false | none | none |
| »»» methodName | string | false | none | none |
| »»» nativeMethod | boolean | false | none | none |
| code | integer(int32) | false | none | none |
| exceptionName | string | false | none | none |
| localizedMessage | string | false | none | none |
| message | string | false | none | none |
| result | LogoutProcedure | false | none | none |
| stackTrace | [object] | false | none | none |
| » className | string | false | none | none |
| » fileName | string | false | none | none |
| » lineNumber | integer(int32) | false | none | none |
| » methodName | string | false | none | none |
| » nativeMethod | boolean | false | none | none |
| suppressed | [object] | false | none | none |
| » localizedMessage | string | false | none | none |
| » message | string | false | none | none |
| » stackTrace | [object] | false | none | none |
| »» className | string | false | none | none |
| »» fileName | string | false | none | none |
| »» lineNumber | integer(int32) | false | none | none |
| »» methodName | string | false | none | none |
| »» nativeMethod | boolean | false | none | none |
MaxRetryExceededException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
]
}
None
MethodNotAllowedCauseUserPermissionsException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"requiredPermissions": [
"SUPERUSER"
]
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » requiredPermissions | [UserPermission] | false | none | none |
NCCSite
Properties
{
"confStatus": "ON",
"domainReachable": "string",
"dtoStatus": "DELETED",
"id": "string",
"name": "string",
"ownerPanels": [
"string"
],
"pbxStatus": "ON",
"trunk": {
"dtoStatus": "DELETED",
"host": "string",
"name": "string",
"ownerPanels": [
"string"
],
"status": "UNKNOWN",
"type": "SIP"
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| confStatus | string | false | none | none |
| domainReachable | string | false | none | none |
| dtoStatus | string | false | none | none |
| id | string | false | none | none |
| name | string | false | none | none |
| ownerPanels | [string] | false | none | none |
| pbxStatus | string | false | none | none |
| trunk | Trunk | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| confStatus | ON |
| confStatus | OFF |
| confStatus | IN |
| confStatus | OUT |
| dtoStatus | DELETED |
| dtoStatus | NEW |
| dtoStatus | MODIFIED |
| pbxStatus | ON |
| pbxStatus | OFF |
| pbxStatus | IN |
| pbxStatus | OUT |
NetworkFaultToleranceMasterActiveException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
]
}
None
NoFileOnCacheException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"fileName": "string"
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » fileName | string | false | none | none |
OperationIsNotAllowedToUserException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"className": "string",
"field": "string",
"mandatoryPermission": "DEFAULT",
"sessionId": "string",
"value": {}
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » className | string | false | none | none |
| » field | string | false | none | none |
| » mandatoryPermission | string | false | none | none |
| » sessionId | string | false | none | none |
| » value | object | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| mandatoryPermission | DEFAULT |
| mandatoryPermission | NONE |
| mandatoryPermission | READ |
| mandatoryPermission | READ_WRITE |
| mandatoryPermission | READ_ADD |
| mandatoryPermission | READ_WRITE_ADD |
OperationIsNotAllowedToUserProfileException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
]
},
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
]
}
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| cause | object | false | none | none |
| » localizedMessage | string | false | none | none |
| » message | string | false | none | none |
| » stackTrace | [object] | false | none | none |
| »» className | string | false | none | none |
| »» fileName | string | false | none | none |
| »» lineNumber | integer(int32) | false | none | none |
| »» methodName | string | false | none | none |
| »» nativeMethod | boolean | false | none | none |
| » suppressed | [object] | false | none | none |
| »» localizedMessage | string | false | none | none |
| »» message | string | false | none | none |
| »» stackTrace | [object] | false | none | none |
| »»» className | string | false | none | none |
| »»» fileName | string | false | none | none |
| »»» lineNumber | integer(int32) | false | none | none |
| »»» methodName | string | false | none | none |
| »»» nativeMethod | boolean | false | none | none |
| code | integer(int32) | false | none | none |
| exceptionName | string | false | none | none |
| localizedMessage | string | false | none | none |
| message | string | false | none | none |
| stackTrace | [object] | false | none | none |
| » className | string | false | none | none |
| » fileName | string | false | none | none |
| » lineNumber | integer(int32) | false | none | none |
| » methodName | string | false | none | none |
| » nativeMethod | boolean | false | none | none |
| suppressed | [object] | false | none | none |
| » localizedMessage | string | false | none | none |
| » message | string | false | none | none |
| » stackTrace | [object] | false | none | none |
| »» className | string | false | none | none |
| »» fileName | string | false | none | none |
| »» lineNumber | integer(int32) | false | none | none |
| »» methodName | string | false | none | none |
| »» nativeMethod | boolean | false | none | none |
PDCampaign
Power Dialer Campaign
The campaign can be of the following types:
- Call (property
type= "CALL", classPDCampaign) - Instant messaging (property
type= "INSTANT_MESSAGING", classPDCampaignInstantMessaging)
Properties
{
"abilitazioneId": 0,
"busyChannels": 400,
"busyChannelsType": "PRESENT",
"enabled": true,
"endDate": "2019-08-24T14:15:22Z",
"id": 0,
"lists": [
{
"enabled": true,
"listId": 0,
"priority": 0
}
],
"name": "string",
"priority": 1,
"reservedChannels": 100,
"serviceCode": "string",
"startDate": "2019-08-24T14:15:22Z",
"type": "CALL",
"usersToNotify": [
"string"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| abilitazioneId | integer(int32) | false | none | Enable outgoing calls to which the campaign is assigned. If not specified, the global one is used. |
| busyChannels | integer(int32) | false | none | Number of channels involved in exit from TVox Communication for the current campaign calculated as a percentage of the resources on or available from those skillate for the associated service (in %, from 0 to 400). This number is, however, limited by the number of channels reserved to the campaign. |
| busyChannelsType | string | false | none | Type of resources (AVAILABLE / PRESENT). Available Resources (AVAILABLE) are the agents logged in to the service whose status is different from Not Ready (NR) or not ready on busy (BUSY); Total Resources (PRESENT) are the agents logged in to the service. |
| enabled | boolean | true | none | Campaign enabled |
| endDate | string(date-time) | true | none | Campaign end date |
| id | integer(int32) | false | none | Campaing id |
| lists | [PDCampaignList] | false | none | Campaign lists. Not required for instant messaging campaigns |
| name | string | false | none | Campaign name |
| priority | integer(int32) | false | none | Campaign priority (1: low, 10: high). The value assigned is meaningful in situations in which you are working with contemporary campaigns and goes to affect the level of employment of telephone channels by which the TVox Communication evades the contacts of the campaign. |
| reservedChannels | integer(int32) | false | none | Maximum number of telephone channels output from TVox Communication used by the current campaign calculated as a percentage of total channels configured for TVox Communication Power Dialing (in %, from 0 to 100). |
| serviceCode | string | false | none | Power Dialer service for the campaign |
| startDate | string(date-time) | true | none | Campaign start date |
| type | string | true | none | Power Dialer Campaign type |
| usersToNotify | [string] | false | none | List of users to be notified when starting and ending a campaign |
Enumerated Values
| Property | Value |
|---|---|
| busyChannelsType | PRESENT |
| busyChannelsType | AVAILABLE |
| type | CALL |
| type | INSTANT_MESSAGING |
PDCampaignInstantMessaging
Power Dialer Campaign for Instant Messaging.
Property type must be "INSTANT_MESSAGING".
Properties
{
"abilitazioneId": 0,
"busyChannels": 400,
"busyChannelsType": "PRESENT",
"enabled": true,
"endDate": "2019-08-24T14:15:22Z",
"id": 0,
"lists": [
{
"enabled": true,
"listId": 0,
"priority": 0
}
],
"name": "string",
"priority": 1,
"reservedChannels": 100,
"serviceCode": "string",
"startDate": "2019-08-24T14:15:22Z",
"type": "CALL",
"usersToNotify": [
"string"
],
"instantMessagingExternalAccountPhoneId": "string",
"whatsAppMessagesLimit": 0,
"whatsAppTemplate": "string"
}
allOf - discriminator: PDCampaign.type
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | PDCampaign | false | none | Power Dialer Campaign The campaign can be of the following types:
|
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » instantMessagingExternalAccountPhoneId | string | false | none | none |
| » whatsAppMessagesLimit | integer(int32) | false | none | WhatsApp maximum limit of messages that can be sent by the campaign |
| » whatsAppTemplate | string | false | none | WhatsApp Template |
PDCampaignList
Power Dialer Campaign List
Properties
{
"enabled": true,
"listId": 0,
"priority": 0
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| enabled | boolean | false | none | Enable the contact list for the current campaign |
| listId | integer(int32) | false | none | List id |
| priority | integer(int32) | false | none | Percentage weight that you assign to your contacts list to the total. This value takes on meaning when you work with more than one list at the same time associated with the current campaign. |
PDCampaignRun
Power Dialer Campaign Run
Properties
{
"campaignId": 0,
"contacts": [
{
"campaignId": 0,
"customFields": {
"property1": "string",
"property2": "string"
},
"id": "string",
"itemContactType": "T4YOU",
"itemNumber": 0,
"templateLanguage": "IT",
"value": "string"
}
],
"endDate": "2019-08-24T14:15:22Z",
"id": 0,
"instantMessagingEndDate": "2019-08-24T14:15:22Z",
"instantMessagingRunStatus": "DISABLE",
"instantMessagingStartDate": "2019-08-24T14:15:22Z",
"instantMessagingStatusDetail": "string",
"listId": 0,
"name": "string",
"number": "string",
"runStatus": "DISABLE",
"scheduledEndDate": "2019-08-24T14:15:22Z",
"scheduledStartDate": "2019-08-24T14:15:22Z",
"startDate": "2019-08-24T14:15:22Z",
"template": "string"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| campaignId | integer(int32) | true | none | Run campaign id |
| contacts | [PDMcInterfaceItem] | false | none | [Power Dialer List Item (contact) for multi-channel] |
| endDate | string(date-time) | false | none | Run end date |
| id | integer(int32) | false | none | Run id |
| instantMessagingEndDate | string(date-time) | false | none | Run instant messaging end date |
| instantMessagingRunStatus | string | false | none | Power Dialer Campaign Run status |
| instantMessagingStartDate | string(date-time) | false | none | Run instant messaging start date |
| instantMessagingStatusDetail | string | false | none | Run instant messaging status detail |
| listId | integer(int32) | false | none | Run list id |
| name | string | true | none | Run name |
| number | string | false | none | none |
| runStatus | string | false | none | Power Dialer Campaign Run status |
| scheduledEndDate | string(date-time) | false | none | Run scheduled end date |
| scheduledStartDate | string(date-time) | false | none | Run scheduled start date |
| startDate | string(date-time) | false | none | Run start date |
| template | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| instantMessagingRunStatus | DISABLE |
| instantMessagingRunStatus | SCHEDULED |
| instantMessagingRunStatus | ACTIVE |
| instantMessagingRunStatus | ACTIVE_QUEUED |
| instantMessagingRunStatus | EVALUATING_RESULT |
| instantMessagingRunStatus | PENDING |
| instantMessagingRunStatus | STOPPING |
| instantMessagingRunStatus | STOPPED |
| instantMessagingRunStatus | END |
| instantMessagingRunStatus | ERROR |
| runStatus | DISABLE |
| runStatus | SCHEDULED |
| runStatus | ACTIVE |
| runStatus | ACTIVE_QUEUED |
| runStatus | EVALUATING_RESULT |
| runStatus | PENDING |
| runStatus | STOPPING |
| runStatus | STOPPED |
| runStatus | END |
| runStatus | ERROR |
PDConf
Power Dialer general settings
Properties
{
"abilitazione": {
"descrizione": "string",
"id": 0
},
"enabled": true,
"maxChannels": 0,
"ringTimeout": 0
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| abilitazione | Abilitazione | false | none | Enabling for outgoing calls |
| enabled | boolean | false | none | Power Dialing enabled |
| maxChannels | integer(int32) | false | none | Maximum available channels |
| ringTimeout | integer(int32) | false | none | Maximum ring time (seconds) |
PDContactInfo
Power Dialer List Item contact info
Properties
{
"addressbookBackendIds": [
"string"
],
"cap": "string",
"city": "string",
"company": "string",
"country": "string",
"department": "string",
"district": "string",
"id": "string",
"name": "string",
"organization": true,
"otherName": "string",
"street": "string",
"surname": "string",
"vip": true
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| addressbookBackendIds | [string] | false | none | List of addressbook ids in which to create or update the contact. If not specified, the addressbooks associated with the campaign service are used. |
| cap | string | false | none | Contact cap |
| city | string | false | none | Contact city |
| company | string | false | none | Contact company (one of name, surname or company must be specified) |
| country | string | false | none | Contact country |
| department | string | false | none | Contact department |
| district | string | false | none | Contact district |
| id | string | false | none | Contact id |
| name | string | false | none | Contact name (one of name, surname or company must be specified) |
| organization | boolean | true | none | Contact is an organization |
| otherName | string | false | none | Contact other name |
| street | string | false | none | Contact street |
| surname | string | false | none | Contact surname (one of name, surname or company must be specified) |
| vip | boolean | true | none | Contact vip |
PDInterfaceItem
Power Dialer List Item (contact) for call channel
Properties
{
"campaignId": 0,
"contactInfo": {
"addressbookBackendIds": [
"string"
],
"cap": "string",
"city": "string",
"company": "string",
"country": "string",
"department": "string",
"district": "string",
"id": "string",
"name": "string",
"organization": true,
"otherName": "string",
"street": "string",
"surname": "string",
"vip": true
},
"data": [
"string"
],
"deleteResult": "DELETED",
"id": 0,
"itemNumber": 0,
"listId": 0,
"phoneNumber": "string",
"scheduledDate": "2019-08-24T14:15:22Z"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| campaignId | integer(int32) | true | none | Campaign id |
| contactInfo | PDContactInfo | false | none | Power Dialer List Item contact info |
| data | [string] | false | none | Item (contact) attached data. It is essential for the screen popup generation in the operator position. Data array will be joined with a pipe separator and the joined string length can not exceed 1000 characters. |
| deleteResult | string | false | none | Outcome of the contact delete operation. Possible values: DELETED, MARKED_TO_DELETE, NOT_FOUND |
| id | integer(int32) | true | none | Item (contact) id |
| itemNumber | integer(int32) | true | none | Item (contact) phone number id. Uniquely identifies in case an item (contact) has more than one phone number. |
| listId | integer(int32) | false | none | List id |
| phoneNumber | string | true | none | Item (contact) phone number. The number cannot belong to any of the internal numbers (user extension, SIP extension, service extension, short number, etc.) |
| scheduledDate | string(date-time) | false | none | Scheduled date from which the contact is to be called |
Enumerated Values
| Property | Value |
|---|---|
| deleteResult | DELETED |
| deleteResult | MARKED_TO_DELETE |
| deleteResult | NOT_FOUND |
PDList
Power Dialer List
Properties
{
"busyAttempts": 0,
"busyTimeout": 0,
"cancelAttempts": 0,
"cancelTimeout": 0,
"congestionAttempts": 0,
"congestionTimeout": 0,
"id": 0,
"name": "string",
"noAnswerAttempts": 0,
"noAnswerTimeout": 0,
"tvoxClosedAttempts": 0,
"tvoxClosedTimeout": 0
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| busyAttempts | integer(int32) | true | none | Attempts: the contact is busy on another call |
| busyTimeout | integer(int32) | true | none | Timeout between attempts: the contact is busy on another call |
| cancelAttempts | integer(int32) | true | none | Attempts: the contact has answered the call and then hang up before being put in touch with the service associated with the campaign |
| cancelTimeout | integer(int32) | true | none | Timeout between attempts: the contact has answered the call and then hang up before being put in touch with the service associated with the campaign |
| congestionAttempts | integer(int32) | true | none | Attempts: the system TVox Communication Power Dialing found no telephone channel available to make the call or, alternatively, the number dialed is not a valid result |
| congestionTimeout | integer(int32) | true | none | Timeout between attempts: the system TVox Communication Power Dialing found no telephone channel available to make the call or, alternatively, the number dialed is not a valid result |
| id | integer(int32) | false | none | List id |
| name | string | false | none | List name |
| noAnswerAttempts | integer(int32) | true | none | Attempts: no answer provided by the contact called. |
| noAnswerTimeout | integer(int32) | true | none | Timeout between attempts: no answer provided by the contact called |
| tvoxClosedAttempts | integer(int32) | true | none | Attempts: the contact has responded and is still waiting to be served by service TVox Communication associated with the campaign. After expiry of the maximum time to wait on the service contact has been hung up |
| tvoxClosedTimeout | integer(int32) | true | none | Timeout between attempts: the contact has responded and is still waiting to be served by service TVox Communication associated with the campaign. After expiry of the maximum time to wait on the service contact has been hung up |
PDMcInterfaceItem
Power Dialer List Item (contact) for multi-channel
Properties
{
"campaignId": 0,
"customFields": {
"property1": "string",
"property2": "string"
},
"id": "string",
"itemContactType": "T4YOU",
"itemNumber": 0,
"templateLanguage": "IT",
"value": "string"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| campaignId | integer(int32) | true | none | Campaign id |
| customFields | object | false | none | Map of item (contact) custom fields for multi-channel campaigns (e.g. instant messaging). Keys must belong to the following range of strings: CUSTOM_01, CUSTOM_02, ..., CUSTOM_28, CUSTOM_29 |
| » additionalProperties | string | false | none | Map of item (contact) custom fields for multi-channel campaigns (e.g. instant messaging). Keys must belong to the following range of strings: CUSTOM_01, CUSTOM_02, ..., CUSTOM_28, CUSTOM_29 |
| id | string | true | none | Item (contact) id. If the UUID of the contact in TVox addressbook is specified, his Customer Journey will be populated with the interactions generated by the multi-channel campaign (e.g. instant messaging) |
| itemContactType | string | true | none | Power Dialer List Item (contact) type between T4YOU (contact in TVox addressbook) or EXTERNAL (contact NOT in TVox addressbook) |
| itemNumber | integer(int32) | true | none | Item (contact) value id. Uniquely identifies in case an item (contact) has more than one value. |
| templateLanguage | Language | false | none | Language |
| value | string | true | none | Item (contact) value (e.g. phone number for instant messaging) |
Enumerated Values
| Property | Value |
|---|---|
| itemContactType | T4YOU |
| itemContactType | EXTERNAL |
PairInboundRouteBoolean
Disa numbers
Properties
{
"key": {
"bpmId": 0,
"calledNumber": "string",
"calledNumberRegExp": true,
"callerNumber": "string",
"callerNumberRegExp": true,
"description": "string",
"disaEnable": true,
"disaRetry": 0,
"followCalendar": "ENABLED",
"id": 0,
"name": "string",
"serviceType": "IVR",
"type": "USER",
"value": "string"
},
"value": true
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| key | InboundRoute | false | none | Inbound route |
| value | boolean | false | none | none |
PasswordExpiredException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"sessionId": "string"
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » sessionId | string | false | none | none |
PasswordInsecureException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"sessionId": "string"
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » sessionId | string | false | none | none |
PickupGroup
Pickup group
Properties
{
"id": 0,
"name": "string",
"number": "string"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | Id |
| name | string | false | none | Name |
| number | string | false | none | Number |
PoSpeedDialer
Properties
{
"index": 0,
"label": "string",
"value": "string"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| index | integer(int32) | false | none | none |
| label | string | false | none | none |
| value | string | false | none | none |
ProfileType
Properties
"UC"
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | UC |
| anonymous | AG |
| anonymous | AG_EXTERNAL |
| anonymous | AG_REMOTE |
| anonymous | TQM |
| anonymous | UNKNOWN |
Profili
Profiles
Properties
{
"abilitazioneProfile": {
"descrizione": "string",
"id": 0
},
"filtroProfile": {
"descrizione": "string",
"id": 0
},
"id": 0,
"label": "string",
"maxCallInbound": 0,
"recNoticeEnabled": true,
"registration": "DISABLED",
"tvoxStatus": "READY",
"type": "UC",
"username": "string"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| abilitazioneProfile | Abilitazione | false | none | Enabling for outgoing calls |
| filtroProfile | Filter | false | none | none |
| id | integer(int32) | false | none | none |
| label | string | false | none | none |
| maxCallInbound | integer(int32) | false | none | none |
| recNoticeEnabled | boolean | false | none | none |
| registration | string | false | none | none |
| tvoxStatus | string | false | none | none |
| type | ProfileType | false | none | none |
| username | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| registration | DISABLED |
| registration | ENABLED |
| registration | CUSTOMIZABLE |
| registration | AUTO |
| registration | ENABLED_ON_PHONE |
| registration | AUTO_CUSTOMIZABLE |
| tvoxStatus | READY |
| tvoxStatus | NOT_READY |
| tvoxStatus | BOOKED |
| tvoxStatus | BUSY |
| tvoxStatus | NOTLOGGED |
| tvoxStatus | NOT_READY_BUSY |
| tvoxStatus | WNR |
| tvoxStatus | BUSY_dn_call_in |
| tvoxStatus | BUSY_dn_call_out |
| tvoxStatus | BUSY_dn_call_out_private |
| tvoxStatus | BUSY_service |
| tvoxStatus | NR_BUSY_dn_call_in |
| tvoxStatus | NR_BUSY_dn_call_out |
| tvoxStatus | NR_BUSY_dn_call_out_private |
ProfiliAG
Properties
{
"abilitazioneProfile": {
"descrizione": "string",
"id": 0
},
"filtroProfile": {
"descrizione": "string",
"id": 0
},
"id": 0,
"label": "string",
"maxCallInbound": 0,
"recNoticeEnabled": true,
"registration": "DISABLED",
"tvoxStatus": "READY",
"type": "UC",
"username": "string",
"activityCodeEnabled": true,
"breakTimeValue": {
"defaultValue": 0,
"enableDefault": true,
"value": 0
},
"callBackEnable": true,
"callSpyEnabled": true,
"clientSpyEnabled": true,
"enableReturnToTransferer": true,
"groups": [
{
"group": {
"callStrategy": "[",
"descrizione": "string",
"logoutReasonList": {},
"nrTransitionLimit": 0,
"nrTransitionSupervised": true,
"scheduledLoggedProfile": true,
"site": {},
"skillset": "string",
"timeZone": "string",
"type": "["
},
"priority": 0,
"standby": true
}
],
"parkOnServiceEnabled": true,
"pickupOnServiceEnabled": true,
"pin": "string",
"popUpEnabled": true,
"privateParkingMaxDuration": 0,
"productivityEnabled": true,
"profiliMultiChannels": {
"property1": {
"autoanswerOnAgent": {
"defaultValue": true,
"enableDefault": true,
"value": true
},
"clazz": "string",
"enabled": true,
"maxChannel": 0,
"tvoxStatus": "READY"
},
"property2": {
"autoanswerOnAgent": {
"defaultValue": true,
"enableDefault": true,
"value": true
},
"clazz": "string",
"enabled": true,
"maxChannel": 0,
"tvoxStatus": "READY"
}
},
"refuseServiceCallValue": {
"defaultValue": true,
"enableDefault": true,
"value": true
},
"returnToTransferMaxCallOnBusy": 0,
"setStandbyValue": {
"defaultValue": true,
"enableDefault": true,
"value": true
},
"statusAfterLogin": "READY",
"statusManagement": "MANUAL",
"viewRTDValue": {
"defaultValue": true,
"enableDefault": true,
"value": true
},
"vipenable": true
}
allOf - discriminator: Profili.type
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | Profili | false | none | Profiles |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » activityCodeEnabled | boolean | false | none | none |
| » breakTimeValue | ValueInteger | false | none | WebClient log minutes value |
| » callBackEnable | boolean | false | none | none |
| » callSpyEnabled | boolean | false | none | none |
| » clientSpyEnabled | boolean | false | none | none |
| » enableReturnToTransferer | boolean | false | none | none |
| » groups | [ProfiliGroupCC] | false | none | none |
| » parkOnServiceEnabled | boolean | false | none | none |
| » pickupOnServiceEnabled | boolean | false | none | none |
| » pin | string | false | none | none |
| » popUpEnabled | boolean | false | none | none |
| » privateParkingMaxDuration | integer(int32) | false | none | none |
| » productivityEnabled | boolean | false | none | none |
| » profiliMultiChannels | object | false | none | none |
| »» additionalProperties | ProfiliMultiChannel | false | none | none |
| » refuseServiceCallValue | ValueBoolean | false | none | WebClient log value |
| » returnToTransferMaxCallOnBusy | integer(int32) | false | none | none |
| » setStandbyValue | ValueBoolean | false | none | WebClient log value |
| » statusAfterLogin | string | false | none | none |
| » statusManagement | string | false | none | none |
| » viewRTDValue | ValueBoolean | false | none | WebClient log value |
| » vipenable | boolean | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| statusAfterLogin | READY |
| statusAfterLogin | NOT_READY |
| statusAfterLogin | BOOKED |
| statusAfterLogin | BUSY |
| statusAfterLogin | NOTLOGGED |
| statusAfterLogin | NOT_READY_BUSY |
| statusAfterLogin | WNR |
| statusAfterLogin | BUSY_dn_call_in |
| statusAfterLogin | BUSY_dn_call_out |
| statusAfterLogin | BUSY_dn_call_out_private |
| statusAfterLogin | BUSY_service |
| statusAfterLogin | NR_BUSY_dn_call_in |
| statusAfterLogin | NR_BUSY_dn_call_out |
| statusAfterLogin | NR_BUSY_dn_call_out_private |
| statusManagement | MANUAL |
| statusManagement | PRESERVE_READY |
| statusManagement | ALL_READY |
ProfiliAGExternal
Properties
{
"abilitazioneProfile": {
"descrizione": "string",
"id": 0
},
"filtroProfile": {
"descrizione": "string",
"id": 0
},
"id": 0,
"label": "string",
"maxCallInbound": 0,
"recNoticeEnabled": true,
"registration": "DISABLED",
"tvoxStatus": "READY",
"type": "UC",
"username": "string",
"breakTimeValue": {
"defaultValue": 0,
"enableDefault": true,
"value": 0
},
"groups": [
{
"group": {
"callStrategy": "[",
"descrizione": "string",
"logoutReasonList": {},
"nrTransitionLimit": 0,
"nrTransitionSupervised": true,
"scheduledLoggedProfile": true,
"site": {},
"skillset": "string",
"timeZone": "string",
"type": "["
},
"priority": 0,
"standby": true
}
],
"notifyCall": "DISABLED",
"notifyMenuValue": {
"defaultValue": "ENABLED",
"enableDefault": true,
"value": "ENABLED"
},
"pin": "string",
"profiliMultiChannels": {
"property1": {
"autoanswerOnAgent": {
"defaultValue": true,
"enableDefault": true,
"value": true
},
"clazz": "string",
"enabled": true,
"maxChannel": 0,
"tvoxStatus": "READY"
},
"property2": {
"autoanswerOnAgent": {
"defaultValue": true,
"enableDefault": true,
"value": true
},
"clazz": "string",
"enabled": true,
"maxChannel": 0,
"tvoxStatus": "READY"
}
},
"statusAfterLogin": "READY",
"statusManagement": "MANUAL",
"timeoutNRValue": {
"defaultValue": 0,
"enableDefault": true,
"value": 0
},
"vipenable": true
}
allOf - discriminator: Profili.type
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | Profili | false | none | Profiles |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » breakTimeValue | ValueInteger | false | none | WebClient log minutes value |
| » groups | [ProfiliGroupCC] | false | none | none |
| » notifyCall | string | false | none | none |
| » notifyMenuValue | ValueEnabled | false | none | DND notify value |
| » pin | string | false | none | none |
| » profiliMultiChannels | object | false | none | none |
| »» additionalProperties | ProfiliMultiChannel | false | none | none |
| » statusAfterLogin | string | false | none | none |
| » statusManagement | string | false | none | none |
| » timeoutNRValue | ValueInteger | false | none | WebClient log minutes value |
| » vipenable | boolean | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| notifyCall | DISABLED |
| notifyCall | SMS |
| notifyCall | SMS_LOST |
| notifyCall | SMS_ANSWER |
| statusAfterLogin | READY |
| statusAfterLogin | NOT_READY |
| statusAfterLogin | BOOKED |
| statusAfterLogin | BUSY |
| statusAfterLogin | NOTLOGGED |
| statusAfterLogin | NOT_READY_BUSY |
| statusAfterLogin | WNR |
| statusAfterLogin | BUSY_dn_call_in |
| statusAfterLogin | BUSY_dn_call_out |
| statusAfterLogin | BUSY_dn_call_out_private |
| statusAfterLogin | BUSY_service |
| statusAfterLogin | NR_BUSY_dn_call_in |
| statusAfterLogin | NR_BUSY_dn_call_out |
| statusAfterLogin | NR_BUSY_dn_call_out_private |
| statusManagement | MANUAL |
| statusManagement | PRESERVE_READY |
| statusManagement | ALL_READY |
ProfiliAGRemote
Properties
{
"abilitazioneProfile": {
"descrizione": "string",
"id": 0
},
"filtroProfile": {
"descrizione": "string",
"id": 0
},
"id": 0,
"label": "string",
"maxCallInbound": 0,
"recNoticeEnabled": true,
"registration": "DISABLED",
"tvoxStatus": "READY",
"type": "UC",
"username": "string",
"activityCodeEnabled": true,
"breakTimeValue": {
"defaultValue": 0,
"enableDefault": true,
"value": 0
},
"callBackEnable": true,
"callSpyEnabled": true,
"clientSpyEnabled": true,
"enableReturnToTransferer": true,
"groups": [
{
"group": {
"callStrategy": "[",
"descrizione": "string",
"logoutReasonList": {},
"nrTransitionLimit": 0,
"nrTransitionSupervised": true,
"scheduledLoggedProfile": true,
"site": {},
"skillset": "string",
"timeZone": "string",
"type": "["
},
"priority": 0,
"standby": true
}
],
"pickupOnServiceEnabled": true,
"pin": "string",
"popUpEnabled": true,
"productivityEnabled": true,
"profiliMultiChannels": {
"property1": {
"autoanswerOnAgent": {
"defaultValue": true,
"enableDefault": true,
"value": true
},
"clazz": "string",
"enabled": true,
"maxChannel": 0,
"tvoxStatus": "READY"
},
"property2": {
"autoanswerOnAgent": {
"defaultValue": true,
"enableDefault": true,
"value": true
},
"clazz": "string",
"enabled": true,
"maxChannel": 0,
"tvoxStatus": "READY"
}
},
"refuseServiceCallValue": {
"defaultValue": true,
"enableDefault": true,
"value": true
},
"returnToTransferMaxCallOnBusy": 0,
"statusAfterLogin": "READY",
"statusManagement": "MANUAL",
"vipenable": true
}
allOf - discriminator: Profili.type
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | Profili | false | none | Profiles |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » activityCodeEnabled | boolean | false | none | none |
| » breakTimeValue | ValueInteger | false | none | WebClient log minutes value |
| » callBackEnable | boolean | false | none | none |
| » callSpyEnabled | boolean | false | none | none |
| » clientSpyEnabled | boolean | false | none | none |
| » enableReturnToTransferer | boolean | false | none | none |
| » groups | [ProfiliGroupCC] | false | none | none |
| » pickupOnServiceEnabled | boolean | false | none | none |
| » pin | string | false | none | none |
| » popUpEnabled | boolean | false | none | none |
| » productivityEnabled | boolean | false | none | none |
| » profiliMultiChannels | object | false | none | none |
| »» additionalProperties | ProfiliMultiChannel | false | none | none |
| » refuseServiceCallValue | ValueBoolean | false | none | WebClient log value |
| » returnToTransferMaxCallOnBusy | integer(int32) | false | none | none |
| » statusAfterLogin | string | false | none | none |
| » statusManagement | string | false | none | none |
| » vipenable | boolean | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| statusAfterLogin | READY |
| statusAfterLogin | NOT_READY |
| statusAfterLogin | BOOKED |
| statusAfterLogin | BUSY |
| statusAfterLogin | NOTLOGGED |
| statusAfterLogin | NOT_READY_BUSY |
| statusAfterLogin | WNR |
| statusAfterLogin | BUSY_dn_call_in |
| statusAfterLogin | BUSY_dn_call_out |
| statusAfterLogin | BUSY_dn_call_out_private |
| statusAfterLogin | BUSY_service |
| statusAfterLogin | NR_BUSY_dn_call_in |
| statusAfterLogin | NR_BUSY_dn_call_out |
| statusAfterLogin | NR_BUSY_dn_call_out_private |
| statusManagement | MANUAL |
| statusManagement | PRESERVE_READY |
| statusManagement | ALL_READY |
ProfiliGroupCC
Properties
{
"group": {
"callStrategy": "RING_ALL_READY",
"descrizione": "string",
"logoutReasonList": {
"codes": [
{
"code": "string",
"list": "string",
"value": "string"
}
],
"description": "string",
"id": "string"
},
"nrTransitionLimit": 0,
"nrTransitionSupervised": true,
"scheduledLoggedProfile": true,
"site": {
"confStatus": "ON",
"domainReachable": "string",
"dtoStatus": "DELETED",
"id": "string",
"name": "string",
"ownerPanels": [
"string"
],
"pbxStatus": "ON",
"trunk": {
"dtoStatus": "DELETED",
"host": "string",
"name": "string",
"ownerPanels": [
"string"
],
"status": "UNKNOWN",
"type": "SIP"
}
},
"skillset": "string",
"timeZone": "string",
"type": "CALLCENTER"
},
"priority": 0,
"standby": true
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| group | GroupCC | false | none | none |
| priority | integer(int32) | false | none | none |
| standby | boolean | false | none | none |
ProfiliGroupHG
Properties
{
"group": {
"callStrategy": "RING_ALL",
"descrizione": "string",
"skillset": "string",
"type": "CALLCENTER"
},
"type": "RING_ALL"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| group | GroupHG | false | none | none |
| type | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| type | RING_ALL |
| type | HUNT |
| type | ID_CALL_UC |
| type | RING_ALL_CONFERENCE |
| type | RING_ALL_CONFERENCE_AUTOANSWER |
| type | DIR_SEG |
| type | ASS_SEG |
| type | DIR_SEG_XOR |
ProfiliGroupHGAssSeg
Properties
{
"group": {
"callStrategy": "RING_ALL",
"descrizione": "string",
"skillset": "string",
"type": "CALLCENTER"
},
"type": "RING_ALL",
"assessore": true,
"standby": true
}
allOf - discriminator: ProfiliGroupHG.type
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | ProfiliGroupHG | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » assessore | boolean | false | none | none |
| » standby | boolean | false | none | none |
ProfiliGroupHGDirExclusive
Properties
{
"group": {
"callStrategy": "RING_ALL",
"descrizione": "string",
"skillset": "string",
"type": "CALLCENTER"
},
"type": "RING_ALL",
"dirigente": true,
"standby": true
}
allOf - discriminator: ProfiliGroupHG.type
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | ProfiliGroupHG | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » dirigente | boolean | false | none | none |
| » standby | boolean | false | none | none |
ProfiliGroupHGDirSeg
Properties
{
"group": {
"callStrategy": "RING_ALL",
"descrizione": "string",
"skillset": "string",
"type": "CALLCENTER"
},
"type": "RING_ALL",
"dirigente": true,
"standby": true
}
allOf - discriminator: ProfiliGroupHG.type
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | ProfiliGroupHG | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » dirigente | boolean | false | none | none |
| » standby | boolean | false | none | none |
ProfiliGroupHGHunt
Properties
{
"group": {
"callStrategy": "RING_ALL",
"descrizione": "string",
"skillset": "string",
"type": "CALLCENTER"
},
"type": "RING_ALL",
"position": 0,
"ringTime": 0
}
allOf - discriminator: ProfiliGroupHG.type
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | ProfiliGroupHG | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » position | integer(int32) | false | none | none |
| » ringTime | integer(int32) | false | none | none |
ProfiliGroupHGIdCallUc
Properties
{
"group": {
"callStrategy": "RING_ALL",
"descrizione": "string",
"skillset": "string",
"type": "CALLCENTER"
},
"type": "RING_ALL"
}
None
ProfiliGroupHGRingAll
Properties
{
"group": {
"callStrategy": "RING_ALL",
"descrizione": "string",
"skillset": "string",
"type": "CALLCENTER"
},
"type": "RING_ALL"
}
None
ProfiliGroupHGRingAllConference
Properties
{
"group": {
"callStrategy": "RING_ALL",
"descrizione": "string",
"skillset": "string",
"type": "CALLCENTER"
},
"type": "RING_ALL"
}
None
ProfiliGroupHGRingAllConferenceAutoanswer
Properties
{
"group": {
"callStrategy": "RING_ALL",
"descrizione": "string",
"skillset": "string",
"type": "CALLCENTER"
},
"type": "RING_ALL"
}
None
ProfiliGroupTQM
Properties
{
"group": {
"callStrategy": "RING_ALL_READY",
"descrizione": "string",
"skillset": "string",
"type": "CALLCENTER"
},
"priority": 0,
"standby": true
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| group | GroupTQM | false | none | none |
| priority | integer(int32) | false | none | none |
| standby | boolean | false | none | none |
ProfiliMultiChannel
Properties
{
"autoanswerOnAgent": {
"defaultValue": true,
"enableDefault": true,
"value": true
},
"clazz": "string",
"enabled": true,
"maxChannel": 0,
"tvoxStatus": "READY"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| autoanswerOnAgent | ValueBoolean | false | none | WebClient log value |
| clazz | string | true | none | none |
| enabled | boolean | false | none | none |
| maxChannel | integer(int32) | false | none | none |
| tvoxStatus | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| tvoxStatus | READY |
| tvoxStatus | NOT_READY |
| tvoxStatus | BOOKED |
| tvoxStatus | BUSY |
| tvoxStatus | NOTLOGGED |
| tvoxStatus | NOT_READY_BUSY |
| tvoxStatus | WNR |
| tvoxStatus | BUSY_dn_call_in |
| tvoxStatus | BUSY_dn_call_out |
| tvoxStatus | BUSY_dn_call_out_private |
| tvoxStatus | BUSY_service |
| tvoxStatus | NR_BUSY_dn_call_in |
| tvoxStatus | NR_BUSY_dn_call_out |
| tvoxStatus | NR_BUSY_dn_call_out_private |
ProfiliMultiChannelChat
Properties
{
"autoanswerOnAgent": {
"defaultValue": true,
"enableDefault": true,
"value": true
},
"clazz": "string",
"enabled": true,
"maxChannel": 0,
"tvoxStatus": "READY",
"whatsAppTwilioEnabled": true,
"widgetEnabled": true
}
allOf - discriminator: ProfiliMultiChannel.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | ProfiliMultiChannel | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » whatsAppTwilioEnabled | boolean | false | none | none |
| » widgetEnabled | boolean | false | none | none |
ProfiliMultiChannelMail
Properties
{
"autoanswerOnAgent": {
"defaultValue": true,
"enableDefault": true,
"value": true
},
"clazz": "string",
"enabled": true,
"maxChannel": 0,
"tvoxStatus": "READY",
"emailMc1002": true,
"facebookMc1002": true,
"preticketingEnabled": true,
"supportServices": [
"string"
],
"telegramMc1002": true,
"twitterMc1002": true
}
allOf - discriminator: ProfiliMultiChannel.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | ProfiliMultiChannel | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » emailMc1002 | boolean | false | none | none |
| » facebookMc1002 | boolean | false | none | none |
| » preticketingEnabled | boolean | false | none | none |
| » supportServices | [string] | false | none | none |
| » telegramMc1002 | boolean | false | none | none |
| » twitterMc1002 | boolean | false | none | none |
ProfiliMultiChannelMailLight
Properties
{
"enabled": true,
"supportServices": [
"string"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| enabled | boolean | false | none | none |
| supportServices | [string] | false | none | none |
ProfiliTQM
Properties
{
"abilitazioneProfile": {
"descrizione": "string",
"id": 0
},
"filtroProfile": {
"descrizione": "string",
"id": 0
},
"id": 0,
"label": "string",
"maxCallInbound": 0,
"recNoticeEnabled": true,
"registration": "DISABLED",
"tvoxStatus": "READY",
"type": "UC",
"username": "string",
"activityCodeEnabled": true,
"callBackEnable": true,
"groups": [
{
"group": {
"callStrategy": "[",
"descrizione": "string",
"skillset": "string",
"type": "["
},
"priority": 0,
"standby": true
}
],
"isTransferModeBlind": {
"defaultValue": true,
"enableDefault": true,
"value": true
},
"pickupOnServiceEnabled": true,
"pin": "string",
"popUpEnabled": true,
"privateParkingMaxDuration": 0,
"profiliMultiChannels": {
"property1": {
"autoanswerOnAgent": {
"defaultValue": true,
"enableDefault": true,
"value": true
},
"clazz": "string",
"enabled": true,
"maxChannel": 0,
"tvoxStatus": "READY"
},
"property2": {
"autoanswerOnAgent": {
"defaultValue": true,
"enableDefault": true,
"value": true
},
"clazz": "string",
"enabled": true,
"maxChannel": 0,
"tvoxStatus": "READY"
}
},
"setStandbyValue": {
"defaultValue": true,
"enableDefault": true,
"value": true
},
"statusAfterLogin": "READY",
"viewRTDValue": {
"defaultValue": true,
"enableDefault": true,
"value": true
},
"vipenable": true,
"visualAcuityConfiguration": {
"altF12Field": "TEL1",
"alternativeResearchFeatureExternal": "N",
"alternativeResearchFeatureInternal": "N",
"brailleFeatures": [
"on_addressbook"
],
"ctrlF12Field": "TEL1",
"instruments": [
"sv"
],
"ipoFeatures": [
"ici_top"
],
"keyToAction": {
"f10Action": "HELP",
"f11Action": "HELP",
"f12Action": "HELP",
"f1Action": "HELP",
"f2Action": "HELP",
"f3Action": "HELP",
"f4Action": "HELP",
"f5Action": "HELP",
"f6Action": "HELP",
"f7Action": "HELP",
"f8Action": "HELP",
"f9Action": "HELP"
},
"notesEnabled": true,
"phoneKeypadEnabled": true,
"shiftF12Field": "TEL1",
"showCallLookup": true,
"speedDialers": [
{
"index": 0,
"label": "string",
"value": "string"
}
],
"synthVocalFeatures": [
"on_number"
],
"themeStyleChoosen": "string",
"type": "v"
}
}
allOf - discriminator: Profili.type
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | Profili | false | none | Profiles |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » activityCodeEnabled | boolean | false | none | none |
| » callBackEnable | boolean | false | none | none |
| » groups | [ProfiliGroupTQM] | false | none | none |
| » isTransferModeBlind | ValueBoolean | false | none | WebClient log value |
| » pickupOnServiceEnabled | boolean | false | none | none |
| » pin | string | false | none | none |
| » popUpEnabled | boolean | false | none | none |
| » privateParkingMaxDuration | integer(int32) | false | none | none |
| » profiliMultiChannels | object | false | none | none |
| »» additionalProperties | ProfiliMultiChannel | false | none | none |
| » setStandbyValue | ValueBoolean | false | none | WebClient log value |
| » statusAfterLogin | string | false | none | none |
| » viewRTDValue | ValueBoolean | false | none | WebClient log value |
| » vipenable | boolean | false | none | none |
| » visualAcuityConfiguration | VisualAcuityConfiguration | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| statusAfterLogin | READY |
| statusAfterLogin | NOT_READY |
| statusAfterLogin | BOOKED |
| statusAfterLogin | BUSY |
| statusAfterLogin | NOTLOGGED |
| statusAfterLogin | NOT_READY_BUSY |
| statusAfterLogin | WNR |
| statusAfterLogin | BUSY_dn_call_in |
| statusAfterLogin | BUSY_dn_call_out |
| statusAfterLogin | BUSY_dn_call_out_private |
| statusAfterLogin | BUSY_service |
| statusAfterLogin | NR_BUSY_dn_call_in |
| statusAfterLogin | NR_BUSY_dn_call_out |
| statusAfterLogin | NR_BUSY_dn_call_out_private |
ProfiliTQMMultiChannelMail
Properties
{
"autoanswerOnAgent": {
"defaultValue": true,
"enableDefault": true,
"value": true
},
"clazz": "string",
"enabled": true,
"maxChannel": 0,
"tvoxStatus": "READY",
"preticketingEnabled": true,
"primarySupportServices": [
"string"
],
"secondarySupportServices": [
"string"
]
}
allOf - discriminator: ProfiliMultiChannel.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | ProfiliMultiChannel | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » preticketingEnabled | boolean | false | none | none |
| » primarySupportServices | [string] | false | none | none |
| » secondarySupportServices | [string] | false | none | none |
ProfiliUC
Properties
{
"abilitazioneProfile": {
"descrizione": "string",
"id": 0
},
"filtroProfile": {
"descrizione": "string",
"id": 0
},
"id": 0,
"label": "string",
"maxCallInbound": 0,
"recNoticeEnabled": true,
"registration": "DISABLED",
"tvoxStatus": "READY",
"type": "UC",
"username": "string",
"enableReturnToTransferer": true,
"groups": [
{
"group": {
"callStrategy": "[",
"descrizione": "string",
"skillset": "string",
"type": "["
},
"type": "RING_ALL"
}
],
"lightSupportChannel": {
"enabled": true,
"supportServices": [
"string"
]
},
"returnToTransferMaxCallOnBusy": 0
}
allOf - discriminator: Profili.type
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | Profili | false | none | Profiles |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » enableReturnToTransferer | boolean | false | none | none |
| » groups | [ProfiliGroupHG] | false | none | none |
| » lightSupportChannel | ProfiliMultiChannelMailLight | false | none | none |
| » returnToTransferMaxCallOnBusy | integer(int32) | false | none | none |
RecordingException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
]
},
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"status": "OK",
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
]
}
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| cause | object | false | none | none |
| » localizedMessage | string | false | none | none |
| » message | string | false | none | none |
| » stackTrace | [object] | false | none | none |
| »» className | string | false | none | none |
| »» fileName | string | false | none | none |
| »» lineNumber | integer(int32) | false | none | none |
| »» methodName | string | false | none | none |
| »» nativeMethod | boolean | false | none | none |
| » suppressed | [object] | false | none | none |
| »» localizedMessage | string | false | none | none |
| »» message | string | false | none | none |
| »» stackTrace | [object] | false | none | none |
| »»» className | string | false | none | none |
| »»» fileName | string | false | none | none |
| »»» lineNumber | integer(int32) | false | none | none |
| »»» methodName | string | false | none | none |
| »»» nativeMethod | boolean | false | none | none |
| code | integer(int32) | false | none | none |
| exceptionName | string | false | none | none |
| localizedMessage | string | false | none | none |
| message | string | false | none | none |
| stackTrace | [object] | false | none | none |
| » className | string | false | none | none |
| » fileName | string | false | none | none |
| » lineNumber | integer(int32) | false | none | none |
| » methodName | string | false | none | none |
| » nativeMethod | boolean | false | none | none |
| status | string | false | none | none |
| suppressed | [object] | false | none | none |
| » localizedMessage | string | false | none | none |
| » message | string | false | none | none |
| » stackTrace | [object] | false | none | none |
| »» className | string | false | none | none |
| »» fileName | string | false | none | none |
| »» lineNumber | integer(int32) | false | none | none |
| »» methodName | string | false | none | none |
| »» nativeMethod | boolean | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| status | OK |
| status | UNKNOWN |
| status | ERROR |
| status | ERROR_NO_LIC |
| status | ERROR_MONITOR_ON |
| status | ERROR_MONITOR_OFF |
| status | ERROR_NO_PERMISSION |
ReportDatamodelException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
]
}
None
ReportSearchRequestObjectDatamodelSearchPowerDialerInstantMessagingCampaignStatusDatamodelSortKeyPowerDialerEntry
Properties
{
"pagination": {
"pageNumber": 0,
"pageSize": 0
},
"resultFields": {},
"search": {
"campaign": {
"abilitation": {
"description": {
"operator": null,
"regexp": null,
"value": null
},
"enabled": true,
"id": {
"operator": null,
"value": null
}
},
"enabled": true,
"id": {
"operator": "NULL",
"value": [
0
]
},
"list": {
"id": {
"operator": null,
"value": null
},
"name": {
"operator": null,
"regexp": null,
"value": null
}
},
"name": {
"operator": "NULL",
"regexp": "string",
"value": [
"string"
]
},
"openFrom": {
"operator": "NULL",
"value": "string",
"valueLeft": "string",
"valueRight": "string"
},
"openTo": {
"operator": "NULL",
"value": "string",
"valueLeft": "string",
"valueRight": "string"
},
"priority": {
"operator": "NULL",
"value": [
0
]
},
"service": {
"code": {
"operator": null,
"regexp": null,
"value": null
},
"description": {
"operator": null,
"regexp": null,
"value": null
},
"serviceType": [
"["
]
}
},
"executionId": {
"operator": "NULL",
"value": [
0
]
},
"listId": {
"operator": "NULL",
"value": [
0
]
},
"month": 0,
"status": {
"operator": "NULL",
"regexp": "string",
"value": [
"string"
]
},
"year": 0
},
"sorting": {
"orderField": "CALL_TIME",
"orderType": "ASC"
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| pagination | SearchLimit | false | none | Pagination |
| resultFields | object | false | none | none |
| search | DatamodelSearchPowerDialerInstantMessagingCampaignStatus | false | none | none |
| sorting | SearchOrderDatamodelSortKeyPowerDialerEntry | false | none | Sorting |
ReportSearchRequestObjectDatamodelSearchPowerDialerInstantMessagingHistoryDatamodelPowerDialerInstantMessagingHistorySortField
Properties
{
"pagination": {
"pageNumber": 0,
"pageSize": 0
},
"resultFields": {},
"search": {
"campaign": {
"abilitation": {
"description": {
"operator": null,
"regexp": null,
"value": null
},
"enabled": true,
"id": {
"operator": null,
"value": null
}
},
"enabled": true,
"id": {
"operator": "NULL",
"value": [
0
]
},
"list": {
"id": {
"operator": null,
"value": null
},
"name": {
"operator": null,
"regexp": null,
"value": null
}
},
"name": {
"operator": "NULL",
"regexp": "string",
"value": [
"string"
]
},
"openFrom": {
"operator": "NULL",
"value": "string",
"valueLeft": "string",
"valueRight": "string"
},
"openTo": {
"operator": "NULL",
"value": "string",
"valueLeft": "string",
"valueRight": "string"
},
"priority": {
"operator": "NULL",
"value": [
0
]
},
"service": {
"code": {
"operator": null,
"regexp": null,
"value": null
},
"description": {
"operator": null,
"regexp": null,
"value": null
},
"serviceType": [
"["
]
}
},
"contactCustomId": {
"operator": "NULL",
"regexp": "string",
"value": [
"string"
]
},
"contactItem": {
"operator": "NULL",
"value": [
0
]
},
"contactUUID": {
"operator": "NULL",
"regexp": "string",
"value": [
"string"
]
},
"executionId": {
"operator": "NULL",
"value": [
0
]
},
"listId": {
"operator": "NULL",
"value": [
0
]
},
"messageCloseTime": {
"operator": "NULL",
"value": "string",
"valueLeft": "string",
"valueRight": "string"
},
"messageFromNumber": {
"operator": "NULL",
"regexp": "string",
"value": [
"string"
]
},
"messageId": {
"operator": "NULL",
"regexp": "string",
"value": [
"string"
]
},
"messageInsertTime": {
"operator": "NULL",
"value": "string",
"valueLeft": "string",
"valueRight": "string"
},
"messageResult": {
"operator": "NULL",
"value": [
0
]
},
"messageToNumber": {
"operator": "NULL",
"regexp": "string",
"value": [
"string"
]
},
"month": 0,
"year": 0
},
"sorting": {
"orderField": "MESSAGE_ID",
"orderType": "ASC"
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| pagination | SearchLimit | false | none | Pagination |
| resultFields | object | false | none | none |
| search | DatamodelSearchPowerDialerInstantMessagingHistory | false | none | none |
| sorting | SearchOrderDatamodelPowerDialerInstantMessagingHistorySortField | false | none | Sorting |
ReportTableNotMigratedException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"tableName": "string"
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » tableName | string | false | none | none |
ReportTooManyRequestsException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
]
}
None
RocketChatUserConfiguration
RocketChat user configuration
Properties
{
"roles": [
"ADMIN"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| roles | [string] | false | none | Roles |
RunScriptCompilationException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
]
}
None
RunScriptExecutionException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"runErrorMessage": "string"
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » runErrorMessage | string | false | none | none |
RunScriptTimeoutException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"maxTime": 0,
"maxTimeSeconds": 0
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » maxTime | integer(int32) | false | none | none |
| » maxTimeSeconds | integer(int32) | false | none | none |
SearchLimit
Pagination
Properties
{
"pageNumber": 0,
"pageSize": 0
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| pageNumber | integer(int32) | false | none | Page number (must be greater than 0) |
| pageSize | integer(int32) | false | none | Page size (must be greater than 0) |
SearchOrderDatamodelPowerDialerInstantMessagingHistorySortField
Sorting
Properties
{
"orderField": "MESSAGE_ID",
"orderType": "ASC"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| orderField | string | false | none | Sorting field |
| orderType | string | false | none | Sorting type (ASC/DESC) |
Enumerated Values
| Property | Value |
|---|---|
| orderField | MESSAGE_ID |
| orderField | CAMPAIGN_ID |
| orderField | LIST_ID |
| orderField | EXECUTION_ID |
| orderField | MESSAGE_INSERT_TIME |
| orderField | MESSAGE_CLOSE_TIME |
| orderField | INSERT_TIME |
| orderType | ASC |
| orderType | DESC |
SearchOrderDatamodelSortKeyPowerDialerEntry
Sorting
Properties
{
"orderField": "CALL_TIME",
"orderType": "ASC"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| orderField | string | false | none | Sorting field |
| orderType | string | false | none | Sorting type (ASC/DESC) |
Enumerated Values
| Property | Value |
|---|---|
| orderField | CALL_TIME |
| orderField | DIAL_SCHED_TIME |
| orderType | ASC |
| orderType | DESC |
SearchOrderUserBaseSortField
Sorting
Properties
{
"orderField": "USERNAME",
"orderType": "ASC"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| orderField | string | false | none | Sorting field |
| orderType | string | false | none | Sorting type (ASC/DESC) |
Enumerated Values
| Property | Value |
|---|---|
| orderField | USERNAME |
| orderField | NAME |
| orderField | SURNAME |
| orderField | EXTEN |
| orderField | |
| orderType | ASC |
| orderType | DESC |
SearchResultChatHistoryMessage
Generic search result
Properties
{
"result": [
{
"agent": {
"displayName": "string",
"name": "string",
"surname": "string",
"type": "USER",
"uid": "string",
"username": "string",
"value": "string"
},
"attachment": {
"file": "string",
"fileName": "string",
"mimeType": "string"
},
"channelType": "WIDGET",
"customer": {
"displayName": "string",
"name": "string",
"surname": "string",
"type": "USER",
"uid": "string",
"username": "string",
"value": "string"
},
"id": "string",
"insertTime": "2019-08-24T14:15:22Z",
"message": "string",
"messageId": "string",
"messageType": "OPEN_SESSION",
"readTime": "2019-08-24T14:15:22Z",
"receivedTime": "2019-08-24T14:15:22Z",
"sender": "AGENT",
"service": {
"bpmProcessId": 0,
"code": "string",
"exten": "string",
"name": "string",
"registration": "DISABLED",
"type": "IVR",
"version": 0
},
"sessionId": "string",
"updateTime": "2019-08-24T14:15:22Z"
}
],
"tot": 0
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| result | [ChatHistoryMessage] | false | none | Result list |
| tot | integer(int32) | false | none | Result total size |
SearchResultContactIdentifierWithUserInformations
Generic search result
Properties
{
"result": [
{
"displayName": "string",
"email": "string",
"language": "IT",
"name": "string",
"publicUsername": "string",
"serviceCodes": [
"string"
],
"surname": "string",
"type": "USER",
"uid": "string",
"userIdMc1002": 0,
"username": "string",
"value": "string"
}
],
"tot": 0
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| result | [ContactIdentifierWithUserInformations] | false | none | Result list |
| tot | integer(int32) | false | none | Result total size |
SearchResultPDCampaign
Generic search result
Properties
{
"result": [
{
"abilitazioneId": 0,
"busyChannels": 400,
"busyChannelsType": "PRESENT",
"enabled": true,
"endDate": "2019-08-24T14:15:22Z",
"id": 0,
"lists": [
{
"enabled": true,
"listId": 0,
"priority": 0
}
],
"name": "string",
"priority": 1,
"reservedChannels": 100,
"serviceCode": "string",
"startDate": "2019-08-24T14:15:22Z",
"type": "CALL",
"usersToNotify": [
"string"
]
}
],
"tot": 0
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| result | [PDCampaign] | false | none | Result list |
| tot | integer(int32) | false | none | Result total size |
SearchResultPDCampaignRun
Generic search result
Properties
{
"result": [
{
"campaignId": 0,
"contacts": [
{
"campaignId": 0,
"customFields": {
"property1": "string",
"property2": "string"
},
"id": "string",
"itemContactType": "T4YOU",
"itemNumber": 0,
"templateLanguage": "IT",
"value": "string"
}
],
"endDate": "2019-08-24T14:15:22Z",
"id": 0,
"instantMessagingEndDate": "2019-08-24T14:15:22Z",
"instantMessagingRunStatus": "DISABLE",
"instantMessagingStartDate": "2019-08-24T14:15:22Z",
"instantMessagingStatusDetail": "string",
"listId": 0,
"name": "string",
"number": "string",
"runStatus": "DISABLE",
"scheduledEndDate": "2019-08-24T14:15:22Z",
"scheduledStartDate": "2019-08-24T14:15:22Z",
"startDate": "2019-08-24T14:15:22Z",
"template": "string"
}
],
"tot": 0
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| result | [PDCampaignRun] | false | none | Result list |
| tot | integer(int32) | false | none | Result total size |
SearchResultPDList
Generic search result
Properties
{
"result": [
{
"busyAttempts": 0,
"busyTimeout": 0,
"cancelAttempts": 0,
"cancelTimeout": 0,
"congestionAttempts": 0,
"congestionTimeout": 0,
"id": 0,
"name": "string",
"noAnswerAttempts": 0,
"noAnswerTimeout": 0,
"tvoxClosedAttempts": 0,
"tvoxClosedTimeout": 0
}
],
"tot": 0
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| result | [PDList] | false | none | Result list |
| tot | integer(int32) | false | none | Result total size |
SearchResultUserAutomatedAttendant
Generic search result
Properties
{
"result": [
{
"automatedAttendantConsoleServiceExten": "string",
"exten": "string",
"name": "string",
"publicUsername": "string",
"surname": "string",
"userAvailable": true,
"username": "string"
}
],
"tot": 0
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| result | [UserAutomatedAttendant] | false | none | Result list |
| tot | integer(int32) | false | none | Result total size |
SearchUserAutomatedAttendantRequest
Search user with automated attendant feature enabled request
Properties
{
"limit": {
"pageNumber": 0,
"pageSize": 0
},
"sort": {
"orderField": "USERNAME",
"orderType": "ASC"
},
"term": "string"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| limit | SearchLimit | false | none | Pagination |
| sort | SearchOrderUserBaseSortField | false | none | Sorting |
| term | string | false | none | Term to search within the name or surname of users |
ServerUnavailableException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"service": "string",
"serviceUri": "string"
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » service | string | false | none | none |
| » serviceUri | string | false | none | none |
ServiceBase
Service
Properties
{
"bpmProcessId": 0,
"code": "string",
"exten": "string",
"name": "string",
"registration": "DISABLED",
"type": "IVR",
"version": 0
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| bpmProcessId | integer(int32) | false | none | BPM process id |
| code | string | false | none | Code |
| exten | string | false | none | Exten |
| name | string | false | none | Name |
| registration | string | false | none | none |
| type | ServiceType | false | none | Service type |
| version | integer(int32) | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| registration | DISABLED |
| registration | ENABLED |
| registration | CUSTOMIZABLE |
ServiceCallDetailRecord
Properties
{
"answer": "2019-08-24T14:15:22Z",
"callData": "string",
"callInfo": {
"property1": "string",
"property2": "string"
},
"clid": "string",
"dnis": "string",
"end": "2019-08-24T14:15:22Z",
"recFileName": "string",
"service": "string",
"sipCallId": "string",
"skillset": "string",
"start": "2019-08-24T14:15:22Z",
"uniqueId": "string"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| answer | string(date-time) | false | none | none |
| callData | string | false | none | none |
| callInfo | object | false | none | none |
| » additionalProperties | string | false | none | none |
| clid | string | false | none | none |
| dnis | string | false | none | none |
| end | string(date-time) | false | none | none |
| recFileName | string | false | none | none |
| service | string | false | none | none |
| sipCallId | string | false | none | none |
| skillset | string | false | none | none |
| start | string(date-time) | false | none | none |
| uniqueId | string | false | none | none |
ServiceType
Service type
Properties
"IVR"
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | Service type |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | IVR |
| anonymous | HUNT |
| anonymous | CALLCENTER |
| anonymous | POWER_DIALER |
| anonymous | TQM |
| anonymous | BPM |
| anonymous | CALLCENTERBPM |
| anonymous | HUNTBPM |
| anonymous | TQMBPM |
ShortNumberList
Short number list
Properties
{
"autoInsert": true,
"id": 0,
"name": "string",
"shortNumber": "string"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| autoInsert | boolean | false | none | Automatic insert enabled |
| id | integer(int32) | false | none | Id |
| name | string | false | none | Name |
| shortNumber | string | false | none | Short number |
SkillsetType
Properties
"CALLCENTER"
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | CALLCENTER |
| anonymous | HUNT |
| anonymous | TQM |
SmsSendRequest
SMS send request
Properties
{
"accountId": 0,
"message": "string",
"phoneNumber": "string",
"username": "string"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| accountId | integer(int32) | false | none | SMS Account id to use for sending |
| message | string | true | none | Message to send in SMS |
| phoneNumber | string | true | none | Phone number to send SMS |
| username | string | true | none | User id of user sending SMS |
TTSException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"result": "SUCCESS"
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » result | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| result | SUCCESS |
| result | ERR_INITIALIZATION |
| result | ERR_OPTIONS |
| result | IN_PROGRESS |
| result | MRCP_FAILURE |
| result | MRCP_TERMINATE |
| result | MRCP_CANCEL |
| result | MRCP_UNKNOWN |
| result | PARAM_ERROR |
| result | UNKNOWN |
TVoxUser
TVox User
Properties
{
"abilitazioneForAuthCode": {
"descrizione": "string",
"id": 0
},
"accessList": {
"actionDescription": "string",
"actionType": "HANGUP",
"actionValue": "string",
"id": 0,
"name": "string",
"type": "BLACK",
"values": {
"property1": "string",
"property2": "string"
}
},
"automatedAttendantConsoleEnable": true,
"automatedAttendantConsoleService": "string",
"callFowardSettings": {
"property1": {
"actionInCalendar": {
"actionToDo": "DIAL"
},
"actionOutCalendar": {
"actionToDo": "DIAL"
},
"calendarEnable": true,
"context": "ENABLE_FROM_PHONE",
"extendedCallFowardFuncInCalendar": {
"alternativeAccessCode": "string",
"alternativeNumber": "string",
"alternativeNumberRingTime": 0,
"confirmRequired": true,
"notifyCallFile": {
"content": "string",
"duration": 0,
"erasable": true,
"file": "string",
"musicOnHold": true,
"name": "string",
"producedByTTS": true,
"ttsLanguage": "string",
"ttsProfile": "string",
"ttsType": "string",
"ttsVoice": "string"
},
"notifyCallLost": "EMAIL",
"twinMode": true
},
"extendedCallFowardFuncOutCalendar": {
"alternativeAccessCode": "string",
"alternativeNumber": "string",
"alternativeNumberRingTime": 0,
"confirmRequired": true,
"notifyCallFile": {
"content": "string",
"duration": 0,
"erasable": true,
"file": "string",
"musicOnHold": true,
"name": "string",
"producedByTTS": true,
"ttsLanguage": "string",
"ttsProfile": "string",
"ttsType": "string",
"ttsVoice": "string"
},
"notifyCallLost": "EMAIL",
"twinMode": true
},
"notifyCallLost": "EMAIL",
"ringTimeInCalendar": 0,
"ringTimeOutCalendar": 0,
"status": "ENABLE_ALL"
},
"property2": {
"actionInCalendar": {
"actionToDo": "DIAL"
},
"actionOutCalendar": {
"actionToDo": "DIAL"
},
"calendarEnable": true,
"context": "ENABLE_FROM_PHONE",
"extendedCallFowardFuncInCalendar": {
"alternativeAccessCode": "string",
"alternativeNumber": "string",
"alternativeNumberRingTime": 0,
"confirmRequired": true,
"notifyCallFile": {
"content": "string",
"duration": 0,
"erasable": true,
"file": "string",
"musicOnHold": true,
"name": "string",
"producedByTTS": true,
"ttsLanguage": "string",
"ttsProfile": "string",
"ttsType": "string",
"ttsVoice": "string"
},
"notifyCallLost": "EMAIL",
"twinMode": true
},
"extendedCallFowardFuncOutCalendar": {
"alternativeAccessCode": "string",
"alternativeNumber": "string",
"alternativeNumberRingTime": 0,
"confirmRequired": true,
"notifyCallFile": {
"content": "string",
"duration": 0,
"erasable": true,
"file": "string",
"musicOnHold": true,
"name": "string",
"producedByTTS": true,
"ttsLanguage": "string",
"ttsProfile": "string",
"ttsType": "string",
"ttsVoice": "string"
},
"notifyCallLost": "EMAIL",
"twinMode": true
},
"notifyCallLost": "EMAIL",
"ringTimeInCalendar": 0,
"ringTimeOutCalendar": 0,
"status": "ENABLE_ALL"
}
},
"cliCallForwardEnabledValue": {
"defaultValue": true,
"enableDefault": true,
"value": true
},
"conference": {
"adminpin": "string",
"chooseLanguageEnable": true,
"closeByAdminHangupEnabled": true,
"countPresentMembersEnabled": true,
"enable": true,
"greetingMsg": {
"content": "string",
"duration": 0,
"erasable": true,
"file": "string",
"musicOnHold": true,
"name": "string",
"producedByTTS": true,
"ttsLanguage": "string",
"ttsProfile": "string",
"ttsType": "string",
"ttsVoice": "string"
},
"language": "IT",
"musicOnHoldEnabled": true,
"name": "string",
"notifyAccessEnabled": true,
"notifyTone": true,
"number": "string",
"ownerUser": "string",
"publicNumber": true,
"userAnnounceEnabled": true,
"userpin": "string",
"volMenuEnabled": true,
"waitAdmin": true
},
"configurationPermissionClass": {
"callFowardSettings": {
"property1": {
"actionInCalendar": "DEFAULT",
"actionOutCalendar": "DEFAULT",
"calendarEnable": "DEFAULT",
"context": "ENABLE_FROM_PHONE",
"notifyCallLost": "DEFAULT",
"permission": "DEFAULT",
"ringTimeInCalendar": "DEFAULT",
"ringTimeOutCalendar": "DEFAULT",
"status": "DEFAULT"
},
"property2": {
"actionInCalendar": "DEFAULT",
"actionOutCalendar": "DEFAULT",
"calendarEnable": "DEFAULT",
"context": "ENABLE_FROM_PHONE",
"notifyCallLost": "DEFAULT",
"permission": "DEFAULT",
"ringTimeInCalendar": "DEFAULT",
"ringTimeOutCalendar": "DEFAULT",
"status": "DEFAULT"
}
},
"conference": {
"adminpin": "DEFAULT",
"closeByAdminHangupEnabled": "DEFAULT",
"countPresentMembersEnabled": "DEFAULT",
"enable": "DEFAULT",
"greetingMsg": "DEFAULT",
"musicOnHoldEnabled": "DEFAULT",
"name": "DEFAULT",
"notifyAccessEnabled": "DEFAULT",
"notifyTone": "DEFAULT",
"number": "DEFAULT",
"permission": "DEFAULT",
"userAnnounceEnabled": "DEFAULT",
"userpin": "DEFAULT",
"volMenuEnabled": "DEFAULT",
"waitAdmin": "DEFAULT"
},
"description": "string",
"directory": {
"customFields": {
"property1": "DEFAULT",
"property2": "DEFAULT"
},
"email": "DEFAULT",
"fax": "DEFAULT",
"homePhone": "DEFAULT",
"mobilePhone": "DEFAULT",
"otherPhone": "DEFAULT",
"permission": "DEFAULT"
},
"faxes": "DEFAULT",
"idTVox": 0,
"name": "DEFAULT",
"password": "DEFAULT",
"permission": "DEFAULT",
"pinForPhoneServices": "DEFAULT",
"surname": "DEFAULT",
"username": "DEFAULT",
"voicemail": {
"maxmsg": "DEFAULT",
"password": "DEFAULT",
"permission": "DEFAULT",
"toAttachFile": "DEFAULT",
"toDeleteFile": "DEFAULT",
"toSendEmail": "DEFAULT"
}
},
"currentDevices": [
{
"clientVersion": "string",
"platform": "WEB"
}
],
"customConfigurationPermissionClass": {
"callFowardSettings": {
"property1": {
"actionInCalendar": "DEFAULT",
"actionOutCalendar": "DEFAULT",
"calendarEnable": "DEFAULT",
"context": "ENABLE_FROM_PHONE",
"notifyCallLost": "DEFAULT",
"permission": "DEFAULT",
"ringTimeInCalendar": "DEFAULT",
"ringTimeOutCalendar": "DEFAULT",
"status": "DEFAULT"
},
"property2": {
"actionInCalendar": "DEFAULT",
"actionOutCalendar": "DEFAULT",
"calendarEnable": "DEFAULT",
"context": "ENABLE_FROM_PHONE",
"notifyCallLost": "DEFAULT",
"permission": "DEFAULT",
"ringTimeInCalendar": "DEFAULT",
"ringTimeOutCalendar": "DEFAULT",
"status": "DEFAULT"
}
},
"conference": {
"adminpin": "DEFAULT",
"closeByAdminHangupEnabled": "DEFAULT",
"countPresentMembersEnabled": "DEFAULT",
"enable": "DEFAULT",
"greetingMsg": "DEFAULT",
"musicOnHoldEnabled": "DEFAULT",
"name": "DEFAULT",
"notifyAccessEnabled": "DEFAULT",
"notifyTone": "DEFAULT",
"number": "DEFAULT",
"permission": "DEFAULT",
"userAnnounceEnabled": "DEFAULT",
"userpin": "DEFAULT",
"volMenuEnabled": "DEFAULT",
"waitAdmin": "DEFAULT"
},
"description": "string",
"directory": {
"customFields": {
"property1": "DEFAULT",
"property2": "DEFAULT"
},
"email": "DEFAULT",
"fax": "DEFAULT",
"homePhone": "DEFAULT",
"mobilePhone": "DEFAULT",
"otherPhone": "DEFAULT",
"permission": "DEFAULT"
},
"faxes": "DEFAULT",
"idTVox": 0,
"name": "DEFAULT",
"password": "DEFAULT",
"permission": "DEFAULT",
"pinForPhoneServices": "DEFAULT",
"surname": "DEFAULT",
"username": "DEFAULT",
"voicemail": {
"maxmsg": "DEFAULT",
"password": "DEFAULT",
"permission": "DEFAULT",
"toAttachFile": "DEFAULT",
"toDeleteFile": "DEFAULT",
"toSendEmail": "DEFAULT"
}
},
"customer": {
"display": "string",
"id": "string"
},
"devices": [
{
"mcsEnabled": true,
"type": "WEB_CLIENT",
"webrtcEnabled": true
}
],
"directory": {
"customCli": "string",
"customCliType": "CUST",
"customFields": {
"property1": "string",
"property2": "string"
},
"email": "string",
"fax": "string",
"homePhone": "string",
"mobilePhone": "string",
"otherPhone": "string"
},
"disaNumbers": {
"property1": {
"key": {
"bpmId": 0,
"calledNumber": "string",
"calledNumberRegExp": true,
"callerNumber": "string",
"callerNumberRegExp": true,
"description": "string",
"disaEnable": true,
"disaRetry": 0,
"followCalendar": "ENABLED",
"id": 0,
"name": "string",
"serviceType": "IVR",
"type": "USER",
"value": "string"
},
"value": true
},
"property2": {
"key": {
"bpmId": 0,
"calledNumber": "string",
"calledNumberRegExp": true,
"callerNumber": "string",
"callerNumberRegExp": true,
"description": "string",
"disaEnable": true,
"disaRetry": 0,
"followCalendar": "ENABLED",
"id": 0,
"name": "string",
"serviceType": "IVR",
"type": "USER",
"value": "string"
},
"value": true
}
},
"dndConfValue": {
"defaultValue": "ENABLED",
"enableDefault": true,
"value": "ENABLED"
},
"dndNotifyValue": {
"defaultValue": "ENABLED",
"enableDefault": true,
"value": "ENABLED"
},
"enableAutoPhoneLock": true,
"enableCallFowardExtended": true,
"enableRedirectionToExternalNumer": true,
"faxes": [
{
"administrator": true,
"fax": {
"identifier": 0,
"name": "string"
},
"receiving": "MAIL",
"receivingEnabled": true,
"sending": "MAIL",
"sendingEnabled": true
}
],
"feedbackClientSettings": {
"maxAttachmentsSizeValue": {
"defaultValue": 0,
"enableDefault": true,
"value": 0
},
"sendFeedbackEnabledValue": {
"defaultValue": true,
"enableDefault": true,
"value": true
},
"webClientLogMinutesValue": {
"defaultValue": 0,
"enableDefault": true,
"value": 0
},
"webClientLogValue": {
"defaultValue": true,
"enableDefault": true,
"value": true
}
},
"forgetContactPermission": true,
"knowledgeBasePermission": "DISABLED",
"language": "IT",
"mcDisplayName": "string",
"name": "string",
"number": "string",
"pendingWarnings": [
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
],
"suppressed": [
{
"localizedMessage": null,
"message": null,
"stackTrace": null
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{}
]
}
]
}
],
"pickupGroups": [
{
"id": 0,
"name": "string",
"number": "string"
}
],
"pinForPhoneServices": "string",
"profili": [
{
"abilitazioneProfile": {
"descrizione": "string",
"id": 0
},
"filtroProfile": {
"descrizione": "string",
"id": 0
},
"id": 0,
"label": "string",
"maxCallInbound": 0,
"recNoticeEnabled": true,
"registration": "DISABLED",
"tvoxStatus": "READY",
"type": "UC",
"username": "string"
}
],
"publicNumbers": [
{
"bpmId": 0,
"calledNumber": "string",
"calledNumberRegExp": true,
"callerNumber": "string",
"callerNumberRegExp": true,
"description": "string",
"disaEnable": true,
"disaRetry": 0,
"followCalendar": "ENABLED",
"id": 0,
"name": "string",
"serviceType": "IVR",
"type": "USER",
"value": "string"
}
],
"publicUsername": "string",
"pwdIntrusion": "string",
"rocketChatConfiguration": {
"roles": [
"ADMIN"
]
},
"shortNumberLists": [
{
"autoInsert": true,
"id": 0,
"name": "string",
"shortNumber": "string"
}
],
"site": {
"cliCallForwardEnabled": true,
"id": 0,
"name": "string"
},
"supportUserId": 0,
"surname": "string",
"ucConf": {
"chatEnabled": true,
"externalLookupEnabled": true,
"meetingCreatePermission": {
"defaultValue": true,
"enableDefault": true,
"value": true
},
"outlookPluginEnabled": true,
"persistentInteractionsEnabled": true,
"personalAddressbookEnabled": {
"defaultValue": true,
"enableDefault": true,
"value": true
},
"presenceActive": true,
"roomsVisibilityEnabled": true,
"sendingSMSEnabled": true,
"visible": true
},
"userRoles": [
"string"
],
"username": "string",
"voicemail": {
"language": "IT",
"maxmsg": 0,
"password": "string",
"toAttachFile": true,
"toDeleteFile": true,
"toSendEmail": true,
"uniqueid": 0
},
"zendeskAgentId": 0
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| abilitazioneForAuthCode | Abilitazione | false | none | Enabling for outgoing calls |
| accessList | AccessList | false | none | Access list |
| automatedAttendantConsoleEnable | boolean | false | none | Automated Attendant Console enabled |
| automatedAttendantConsoleService | string | false | none | Automated Attendant Console service |
| callFowardSettings | object | false | none | Call Forward settings |
| » additionalProperties | CallFoward | false | none | Call Forward |
| cliCallForwardEnabledValue | ValueBoolean | false | none | WebClient log value |
| conference | Conference | false | none | Conference |
| configurationPermissionClass | UserClassConfigurationPermission | false | none | User class configuration permission |
| currentDevices | [UserCurrentDevices] | false | none | Current devices |
| customConfigurationPermissionClass | UserClassConfigurationPermission | false | none | User class configuration permission |
| customer | CustomerBase | false | none | none |
| devices | [TVoxUserDevice] | false | none | Devices |
| directory | DirectoryFields | false | none | Directory fields |
| disaNumbers | object | false | none | Disa numbers |
| » additionalProperties | PairInboundRouteBoolean | false | none | Disa numbers |
| dndConfValue | ValueEnabled | false | none | DND notify value |
| dndNotifyValue | ValueEnabled | false | none | DND notify value |
| enableAutoPhoneLock | boolean | false | none | Automatic phone lock enabled |
| enableCallFowardExtended | boolean | false | none | Call Forward enabled |
| enableRedirectionToExternalNumer | boolean | false | none | Redirection to external number enabled |
| faxes | [FaxBoxUser] | false | none | Faxes |
| feedbackClientSettings | FeedbackClientUserSettings | false | none | Feedback client user settings |
| forgetContactPermission | boolean | false | none | Forget contact permission |
| knowledgeBasePermission | string | false | none | Knowledge Base permission |
| language | Language | false | none | Language |
| mcDisplayName | string | false | none | Multichannel display name |
| name | string | false | none | Name |
| number | string | false | none | Number |
| pendingWarnings | [WebAPIException] | false | none | Pending warning |
| pickupGroups | [PickupGroup] | false | none | Pickup groups |
| pinForPhoneServices | string | false | none | PIN for phone services |
| profili | [Profili] | false | none | Profiles |
| publicNumbers | [UserInboundRoute] | false | none | Public numbers |
| publicUsername | string | false | none | Username |
| pwdIntrusion | string | false | none | Password intrusion |
| rocketChatConfiguration | RocketChatUserConfiguration | false | none | RocketChat user configuration |
| shortNumberLists | [ShortNumberList] | false | none | Shor Number lists |
| site | UserSite | false | none | User site |
| supportUserId | integer(int32) | false | none | Support user id |
| surname | string | false | none | Surname |
| ucConf | UCConfiguration | false | none | UC configuration |
| userRoles | [string] | false | none | User roles |
| username | string | false | none | User id |
| voicemail | Voicemail | false | none | Voicemail |
| zendeskAgentId | integer(int64) | false | none | Zendesk agent id |
Enumerated Values
| Property | Value |
|---|---|
| knowledgeBasePermission | DISABLED |
| knowledgeBasePermission | READ |
| knowledgeBasePermission | READWRITE |
TVoxUserAppDevice
User APP device
Properties
{
"mcsEnabled": true,
"type": "WEB_CLIENT",
"webrtcEnabled": true,
"callbackGsmValue": {
"defaultValue": "ENABLED",
"enableDefault": true,
"value": "ENABLED"
},
"clidToPstnList": [
"string"
],
"fallbackGsmValue": {
"defaultValue": "ENABLED",
"enableDefault": true,
"value": "ENABLED"
},
"gsmEnabled": true,
"videoEnabled": true
}
allOf - discriminator: TVoxUserDevice.type
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | TVoxUserDevice | false | none | User device |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » callbackGsmValue | ValueEnabled | false | none | DND notify value |
| » clidToPstnList | [string] | false | none | CLID to PSTN list |
| » fallbackGsmValue | ValueEnabled | false | none | DND notify value |
| » gsmEnabled | boolean | false | none | GSM enabled |
| » videoEnabled | boolean | false | none | Video enabled |
TVoxUserDevice
User device
Properties
{
"mcsEnabled": true,
"type": "WEB_CLIENT",
"webrtcEnabled": true
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| mcsEnabled | boolean | false | none | MCS enabled |
| type | string | false | none | Type |
| webrtcEnabled | boolean | false | none | WebRTC enabled |
Enumerated Values
| Property | Value |
|---|---|
| type | WEB_CLIENT |
| type | APP |
| type | SIP |
| type | EXTERNAL |
TVoxUserExternalDevice
User external device
Properties
{
"mcsEnabled": true,
"type": "WEB_CLIENT",
"webrtcEnabled": true,
"exten": "string"
}
allOf - discriminator: TVoxUserDevice.type
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | TVoxUserDevice | false | none | User device |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » exten | string | false | none | Exten |
TVoxUserSIPDevice
User SIP device
Properties
{
"mcsEnabled": true,
"type": "WEB_CLIENT",
"webrtcEnabled": true,
"defaultExten": true,
"exten": {
"dtoStatus": "DELETED",
"exten": "string",
"host": "string",
"ownerPanels": [
"string"
],
"status": "UNKNOWN",
"type": "MCS_SIP",
"userAgent": "string"
},
"label": {
"id": "string",
"img": "string",
"name": "string",
"position": 0,
"values": {
"property1": "string",
"property2": "string"
}
}
}
allOf - discriminator: TVoxUserDevice.type
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | TVoxUserDevice | false | none | User device |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » defaultExten | boolean | false | none | Default exten |
| » exten | Exten | false | none | Exten |
| » label | ExtenLabel | false | none | Exten label |
TVoxUserWebClientDevice
User WebClient device
Properties
{
"mcsEnabled": true,
"type": "WEB_CLIENT",
"webrtcEnabled": true,
"ucEnabled": true,
"videoEnabled": true
}
allOf - discriminator: TVoxUserDevice.type
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | TVoxUserDevice | false | none | User device |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » ucEnabled | boolean | false | none | UC enabled |
| » videoEnabled | boolean | false | none | Video enabled |
TemplateData
Properties
{
"category": "string",
"category_change": "string",
"components": [
{
"text": "string",
"type": "string"
}
],
"language": "string",
"name": "string",
"status": "string",
"waba_id": "string"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| category | string | false | none | none |
| category_change | string | false | none | none |
| components | [Component] | false | none | none |
| language | string | false | none | none |
| name | string | false | none | none |
| status | string | false | none | none |
| waba_id | string | false | none | none |
TemplatesInformation
Properties
{
"code": "string",
"data": [
{
"category": "string",
"category_change": "string",
"components": [
{
"text": "string",
"type": "string"
}
],
"language": "string",
"name": "string",
"status": "string",
"waba_id": "string"
}
],
"message": "string",
"total": 0
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| code | string | false | none | none |
| data | [TemplateData] | false | none | none |
| message | string | false | none | none |
| total | integer(int32) | false | none | none |
TicketAddArticleNoteRequest
Properties
{
"attachments": [
{
"mimeType": "string",
"name": "string",
"uuid": "string"
}
],
"body": "string",
"internal": true
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| attachments | [FileUpload] | false | none | [Attachments] |
| body | string | true | none | Content of the article |
| internal | boolean | false | none | Is article visible for customer |
TicketArticle
Ticket article
Properties
{
"attachments": [
{
"data": "string",
"filename": "string",
"id": 0,
"mime-type": "string",
"preferences": {
"property1": "string",
"property2": "string"
},
"size": "string"
}
],
"body": "string",
"cc": "string",
"content_type": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"created_by_id": 0,
"from": "string",
"id": 0,
"in_reply_to": "string",
"internal": true,
"message_id": "string",
"message_id_md5": "string",
"origin_by": "string",
"origin_by_id": 0,
"preferences": {
"property1": {},
"property2": {}
},
"references": "string",
"reply_to": "string",
"sender": "Agent",
"sender_id": 0,
"subject": "string",
"ticket_id": 0,
"time_unit": 0,
"to": "string",
"type": "email",
"type_id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"updated_by": "string",
"updated_by_id": 0
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| attachments | [Attachment] | false | none | Attachments |
| body | string | false | none | Content of the article |
| cc | string | false | none | Sender |
| content_type | string | false | none | Content type |
| created_at | string(date-time) | false | none | Article create date (DateTime, UTC) |
| created_by | string | false | none | Who has created the article |
| created_by_id | integer(int32) | false | none | Who (UserID) has created the article |
| from | string | false | none | Sender address of the article |
| id | integer(int32) | false | none | Article id |
| in_reply_to | string | false | none | Content of reply to field |
| internal | boolean | false | none | Is article visible for customer |
| message_id | string | false | none | Message ID (if article was an email) |
| message_id_md5 | string | false | none | Internal message id MD5 Checksum |
| origin_by | string | false | none | For which real user the article creation has been done. For example the customer which was calling on the phone |
| origin_by_id | integer(int32) | false | none | For which real user (UserID) the article creation has been done. For example the customer which was calling on the phone |
| preferences | object | false | none | Hash for additional information |
| » additionalProperties | object | false | none | Hash for additional information |
| references | string | false | none | Email references header |
| reply_to | string | false | none | Content of the reply to field |
| sender | string | false | none | Who is the sender (Customer, Agent) |
| sender_id | integer(int32) | false | none | Which type of user has created the article (Agent, Customer) |
| subject | string | false | none | Article subject |
| ticket_id | integer(int32) | false | none | Referencing ticket ID |
| time_unit | number(float) | false | none | Time accounting on article |
| to | string | false | none | Receiver |
| type | string | false | none | Article type (phone, email, web…) |
| type_id | integer(int32) | false | none | Article type id (phone, email, web…) |
| updated_at | string(date-time) | false | none | Update time of the article (DateTime, UTC) |
| updated_by | string | false | none | Who has updated the article |
| updated_by_id | integer(int32) | false | none | Who (UserID) has updated the article |
Enumerated Values
| Property | Value |
|---|---|
| sender | Agent |
| sender | Customer |
| sender | System |
| type | |
| type | sms |
| type | chat |
| type | fax |
| type | phone |
| type | twitter status |
| type | twitter direct-message |
| type | facebook feed post |
| type | facebook feed comment |
| type | note |
| type | web |
| type | telegram personal-message |
TicketSearchRequest
Properties
{
"context": "IVR",
"customFields": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"customerId": [
"string"
],
"ownerId": [
"string"
],
"pageNumber": 0,
"pageSize": 0,
"serviceCode": [
"string"
],
"stateId": [
"string"
],
"submitterId": "string"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| context | string | true | none | Ticket context |
| customFields | object | false | none | Map of item (contact) custom fields. Keys must belong to the following range of strings: t_custom_01, t_custom_02, ..., t_custom_28, t_custom_29 |
| » additionalProperties | [string] | false | none | Map of item (contact) custom fields. Keys must belong to the following range of strings: t_custom_01, t_custom_02, ..., t_custom_28, t_custom_29 |
| customerId | [string] | false | none | Customer id |
| ownerId | [string] | false | none | Owner id |
| pageNumber | integer(int32) | false | none | Page number |
| pageSize | integer(int32) | false | none | Page size |
| serviceCode | [string] | true | none | Service code |
| stateId | [string] | true | none | Ticket state id for available ticket states (new, open…) |
| submitterId | string | true | none | Agent username if context is AGENT, Customer username if context is CUSTOMER |
Enumerated Values
| Property | Value |
|---|---|
| context | IVR |
| context | SURVEY |
| context | GENERIC |
| context | AGENT |
| context | CUSTOMER |
TicketWithCustomer
Ticket with customer
Properties
{
"article": {
"attachments": [
{
"data": "string",
"filename": "string",
"id": 0,
"mime-type": "string",
"preferences": {
"property1": "string",
"property2": "string"
},
"size": "string"
}
],
"body": "string",
"cc": "string",
"content_type": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"created_by_id": 0,
"from": "string",
"id": 0,
"in_reply_to": "string",
"internal": true,
"message_id": "string",
"message_id_md5": "string",
"origin_by": "string",
"origin_by_id": 0,
"preferences": {
"property1": {},
"property2": {}
},
"references": "string",
"reply_to": "string",
"sender": "Agent",
"sender_id": 0,
"subject": "string",
"ticket_id": 0,
"time_unit": 0,
"to": "string",
"type": "email",
"type_id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"updated_by": "string",
"updated_by_id": 0
},
"article_count": 0,
"article_ids": [
0
],
"articles": [
{
"attachments": [
{
"data": "string",
"filename": "string",
"id": 0,
"mime-type": "string",
"preferences": {
"property1": "string",
"property2": "string"
},
"size": "string"
}
],
"body": "string",
"cc": "string",
"content_type": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"created_by_id": 0,
"from": "string",
"id": 0,
"in_reply_to": "string",
"internal": true,
"message_id": "string",
"message_id_md5": "string",
"origin_by": "string",
"origin_by_id": 0,
"preferences": {
"property1": {},
"property2": {}
},
"references": "string",
"reply_to": "string",
"sender": "Agent",
"sender_id": 0,
"subject": "string",
"ticket_id": 0,
"time_unit": 0,
"to": "string",
"type": "email",
"type_id": 0,
"updated_at": "2019-08-24T14:15:22Z",
"updated_by": "string",
"updated_by_id": 0
}
],
"attachments": [
{
"mimeType": "string",
"name": "string",
"uuid": "string"
}
],
"close_at": "2019-08-24T14:15:22Z",
"close_diff_in_min": 0,
"close_escalation_at": "2019-08-24T14:15:22Z",
"close_in_min": 0,
"create_article_sender": "string",
"create_article_sender_id": 0,
"create_article_type": "string",
"create_article_type_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"created_by_id": 0,
"customer": "string",
"customerContact": {
"type": "USER",
"uid": "string",
"username": "string",
"value": "string"
},
"customer_id": "string",
"escalation_at": "2019-08-24T14:15:22Z",
"first_response_at": "2019-08-24T14:15:22Z",
"first_response_diff_in_min": 0,
"first_response_escalation_at": "2019-08-24T14:15:22Z",
"first_response_in_min": 0,
"group": "string",
"group_id": 0,
"id": 0,
"last_contact_agent_at": "2019-08-24T14:15:22Z",
"last_contact_at": "2019-08-24T14:15:22Z",
"last_contact_customer_at": "2019-08-24T14:15:22Z",
"last_owner_update_at": "2019-08-24T14:15:22Z",
"note": "string",
"number": "string",
"organization": "string",
"organization_id": 0,
"owner": "string",
"ownerContact": {
"type": "USER",
"uid": "string",
"username": "string",
"value": "string"
},
"owner_id": 0,
"pending_time": "2019-08-24T14:15:22Z",
"priority": "1 low",
"priority_id": 0,
"state": "new",
"state_id": 0,
"t_agent_close_date": "2019-08-24T14:15:22Z",
"t_agent_get_date": "2019-08-24T14:15:22Z",
"t_call_link": "string",
"t_create_call_uid": "string",
"t_custom_01": "string",
"t_custom_02": "string",
"t_custom_03": "string",
"t_custom_04": "string",
"t_custom_05": "string",
"t_custom_06": "string",
"t_custom_07": "string",
"t_custom_08": "string",
"t_custom_09": "string",
"t_custom_10": "string",
"t_custom_11": "string",
"t_custom_12": "string",
"t_custom_13": "string",
"t_custom_14": "string",
"t_custom_15": "string",
"t_custom_16": "string",
"t_custom_17": "string",
"t_custom_18": "string",
"t_custom_19": "string",
"t_custom_20": "string",
"t_custom_21": "string",
"t_custom_22": "string",
"t_custom_23": "string",
"t_custom_24": "string",
"t_custom_25": "string",
"t_custom_26": "string",
"t_custom_27": "string",
"t_custom_28": "string",
"t_custom_29": "string",
"t_custom_30": "string",
"t_custom_31": "string",
"t_custom_32": "string",
"t_custom_33": "string",
"t_custom_34": "string",
"t_custom_35": "string",
"t_custom_36": "string",
"t_custom_37": "string",
"t_custom_38": "string",
"t_custom_39": "string",
"t_custom_40": "string",
"t_custom_41": "string",
"t_custom_42": "string",
"t_custom_43": "string",
"t_custom_44": "string",
"t_custom_45": "string",
"t_custom_46": "string",
"t_custom_47": "string",
"t_custom_48": "string",
"t_custom_49": "string",
"t_custom_50": "string",
"t_custom_51": "string",
"t_custom_52": "string",
"t_custom_53": "string",
"t_custom_54": "string",
"t_custom_55": "string",
"t_custom_56": "string",
"t_custom_57": "string",
"t_custom_58": "string",
"t_custom_59": "string",
"t_custom_60": "string",
"t_custom_61": "string",
"t_custom_62": "string",
"t_custom_63": "string",
"t_custom_64": "string",
"t_custom_65": "string",
"t_custom_66": "string",
"t_custom_67": "string",
"t_custom_68": "string",
"t_custom_69": "string",
"t_custom_70": "string",
"t_custom_71": "string",
"t_custom_72": "string",
"t_custom_73": "string",
"t_custom_74": "string",
"t_custom_75": "string",
"t_custom_76": "string",
"t_custom_77": "string",
"t_custom_78": "string",
"t_custom_79": "string",
"t_custom_80": "string",
"t_custom_81": "string",
"t_custom_82": "string",
"t_custom_83": "string",
"t_custom_84": "string",
"t_custom_85": "string",
"t_custom_86": "string",
"t_custom_87": "string",
"t_custom_88": "string",
"t_custom_89": "string",
"t_custom_90": "string",
"t_custom_91": "string",
"t_custom_92": "string",
"t_custom_93": "string",
"t_custom_94": "string",
"t_custom_95": "string",
"t_custom_96": "string",
"t_custom_97": "string",
"t_custom_98": "string",
"t_custom_99": "string",
"t_custom_date_01": "2019-08-24T14:15:22Z",
"t_custom_date_02": "2019-08-24T14:15:22Z",
"t_custom_date_03": "2019-08-24T14:15:22Z",
"t_custom_date_04": "2019-08-24T14:15:22Z",
"t_custom_date_05": "2019-08-24T14:15:22Z",
"t_custom_date_06": "2019-08-24T14:15:22Z",
"t_custom_date_07": "2019-08-24T14:15:22Z",
"t_custom_date_08": "2019-08-24T14:15:22Z",
"t_custom_date_09": "2019-08-24T14:15:22Z",
"t_custom_date_10": "2019-08-24T14:15:22Z",
"t_custom_date_11": "2019-08-24T14:15:22Z",
"t_custom_date_12": "2019-08-24T14:15:22Z",
"t_custom_date_13": "2019-08-24T14:15:22Z",
"t_custom_date_14": "2019-08-24T14:15:22Z",
"t_custom_date_15": "2019-08-24T14:15:22Z",
"t_custom_date_16": "2019-08-24T14:15:22Z",
"t_custom_date_17": "2019-08-24T14:15:22Z",
"t_custom_date_18": "2019-08-24T14:15:22Z",
"t_custom_date_19": "2019-08-24T14:15:22Z",
"t_custom_date_20": "2019-08-24T14:15:22Z",
"t_custom_date_21": "2019-08-24T14:15:22Z",
"t_custom_date_22": "2019-08-24T14:15:22Z",
"t_custom_date_23": "2019-08-24T14:15:22Z",
"t_custom_date_24": "2019-08-24T14:15:22Z",
"t_custom_date_25": "2019-08-24T14:15:22Z",
"t_custom_date_26": "2019-08-24T14:15:22Z",
"t_custom_date_27": "2019-08-24T14:15:22Z",
"t_custom_date_28": "2019-08-24T14:15:22Z",
"t_custom_date_29": "2019-08-24T14:15:22Z",
"t_custom_date_30": "2019-08-24T14:15:22Z",
"t_custom_date_31": "2019-08-24T14:15:22Z",
"t_custom_date_32": "2019-08-24T14:15:22Z",
"t_custom_date_33": "2019-08-24T14:15:22Z",
"t_custom_date_34": "2019-08-24T14:15:22Z",
"t_custom_date_35": "2019-08-24T14:15:22Z",
"t_custom_date_36": "2019-08-24T14:15:22Z",
"t_custom_date_37": "2019-08-24T14:15:22Z",
"t_custom_date_38": "2019-08-24T14:15:22Z",
"t_custom_date_39": "2019-08-24T14:15:22Z",
"t_custom_date_40": "2019-08-24T14:15:22Z",
"t_custom_date_41": "2019-08-24T14:15:22Z",
"t_custom_date_42": "2019-08-24T14:15:22Z",
"t_custom_date_43": "2019-08-24T14:15:22Z",
"t_custom_date_44": "2019-08-24T14:15:22Z",
"t_custom_date_45": "2019-08-24T14:15:22Z",
"t_custom_date_46": "2019-08-24T14:15:22Z",
"t_custom_date_47": "2019-08-24T14:15:22Z",
"t_custom_date_48": "2019-08-24T14:15:22Z",
"t_custom_date_49": "2019-08-24T14:15:22Z",
"t_external_ticketing_add": true,
"t_external_ticketing_link": "string",
"t_forgot_article_count": 0,
"t_forgot_time_unit": 0,
"t_is_child_link": true,
"t_is_forgot_ticket": true,
"t_is_normal_link": true,
"t_is_parent_link": true,
"t_is_view_by_owner": true,
"t_knowledge_base_answer_link": "string",
"t_knowledge_base_answer_uid": "string",
"t_knowledge_base_category_link": "string",
"t_knowledge_base_category_uid": "string",
"t_knowledge_base_id_answer": "string",
"t_knowledge_base_id_category": "string",
"t_last_link_child_update": "string",
"t_last_link_normal_update": "string",
"t_last_link_with": "string",
"t_last_merge_with": "string",
"t_last_owner_view_at": "2019-08-24T14:15:22Z",
"t_queue_type": "string",
"t_reminder_cp_last_time": "2019-08-24T14:15:22Z",
"t_reminder_cp_num": 0,
"t_reminder_tk_last_time": "2019-08-24T14:15:22Z",
"t_reminder_tk_num": 0,
"t_reminder_tk_src": "string",
"t_self_generated_ticket_call_final_state": "string",
"t_self_generated_ticket_type": "string",
"t_social_message_uid": "string",
"t_state_last_update": "2019-08-24T14:15:22Z",
"ticket_time_accounting": [
"string"
],
"ticket_time_accounting_ids": [
0
],
"time_unit": 0,
"title": "string",
"type": "string",
"update_diff_in_min": 0,
"update_escalation_at": "2019-08-24T14:15:22Z",
"update_in_min": 0,
"updated_at": "2019-08-24T14:15:22Z",
"updated_by": "string",
"updated_by_id": 0
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| article | TicketArticle | false | none | Ticket article |
| article_count | integer(int32) | false | none | Count of articles |
| article_ids | [integer] | false | none | Articles' ids |
| articles | [TicketArticle] | false | none | Articles |
| attachments | [FileUpload] | false | none | Attachments |
| close_at | string(date-time) | false | none | First close time, after create |
| close_diff_in_min | integer(int32) | false | none | Business hours in minutes within or above the specified SLA for closing the ticket |
| close_escalation_at | string(date-time) | false | none | Time stamp of the escalation if the SLA of the closing time has been violated. (DateTime, UTC) |
| close_in_min | integer(int32) | false | none | Business hours in minutes it took to close the ticket |
| create_article_sender | string | false | none | Who has created the first article (Agent,Customer) |
| create_article_sender_id | integer(int32) | false | none | Sender id of the first article (Agent |
| create_article_type | string | false | none | Article type for the first article (note, email, phone…) |
| create_article_type_id | integer(int32) | false | none | Article type ID for the first article (note, email, phone…) |
| created_at | string(date-time) | false | none | Created timestamp (DateTime, UTC) |
| created_by | string | false | none | User details of the user who created the ticket |
| created_by_id | integer(int32) | false | none | User id of user who created the ticket |
| customer | string | false | none | Customer details |
| customerContact | ContactIdentifier | true | none | Contact identifier - used on interaction and note |
| customer_id | string | false | none | User id of the current customer (assigned to ticket) |
| escalation_at | string(date-time) | false | none | Next first escalation date (nearest close_escalation_at, first_response_escalation_at or update_escalation_at (DateTime, UTC) |
| first_response_at | string(date-time) | false | none | Time stamp of the first reaction to the customer (DateTime, UTC) |
| first_response_diff_in_min | integer(int32) | false | none | Business hours in minutes within or above the specified SLA for the first reaction to the customer |
| first_response_escalation_at | string(date-time) | false | none | Time stamp of the escalation if the SLA of the first reaction time has been violated. (DateTime, UTC) |
| first_response_in_min | integer(int32) | false | none | Business hours in minutes it took to send inital response to customer |
| group | string | false | none | Current ticket group (Sales, Support…) |
| group_id | integer(int32) | false | none | Current ticket group id |
| id | integer(int32) | false | none | Ticket id |
| last_contact_agent_at | string(date-time) | false | none | Last contact to customer from agent, timestamp (DateTime, UTC) |
| last_contact_at | string(date-time) | false | none | Last contact timestamp (DateTime, UTC) |
| last_contact_customer_at | string(date-time) | false | none | Last contact from a customer, timestamp (DateTime, UTC) |
| last_owner_update_at | string(date-time) | false | none | Last owner update |
| note | string | false | none | Internal note for ticket |
| number | string | false | none | The unique ticket number |
| organization | string | false | none | Name of the organization of a given customer |
| organization_id | integer(int32) | false | none | Id of the organization of a given customer |
| owner | string | false | none | Current owner (agent) |
| ownerContact | ContactIdentifier | false | none | Contact identifier - used on interaction and note |
| owner_id | integer(int32) | false | none | User id of owner |
| pending_time | string(date-time) | false | none | Current pending time (DateTime, UTC) |
| priority | string | false | none | Ticket priority |
| priority_id | integer(int32) | false | none | ID of the currently set priority |
| state | string | false | none | Ticket state (new, open…) |
| state_id | integer(int32) | false | none | Ticket state id for available ticket states (new, open…) |
| t_agent_close_date | string(date-time) | false | none | Date an agent closed the ticket (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_agent_get_date | string(date-time) | false | none | Date an agent took charge of the ticket (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_call_link | string | false | none | Link of the call associated with the ticket |
| t_create_call_uid | string | false | none | In ticket of type call: TVox call Id of the call that generated the ticket |
| t_custom_01 | string | false | none | Telenia custom text field 1 |
| t_custom_02 | string | false | none | Telenia custom text field 2 |
| t_custom_03 | string | false | none | Telenia custom text field 3 |
| t_custom_04 | string | false | none | Telenia custom text field 4 |
| t_custom_05 | string | false | none | Telenia custom text field 5 |
| t_custom_06 | string | false | none | Telenia custom text field 6 |
| t_custom_07 | string | false | none | Telenia custom text field 7 |
| t_custom_08 | string | false | none | Telenia custom text field 8 |
| t_custom_09 | string | false | none | Telenia custom text field 9 |
| t_custom_10 | string | false | none | Telenia custom text field 10 |
| t_custom_11 | string | false | none | Telenia custom text field 11 |
| t_custom_12 | string | false | none | Telenia custom text field 12 |
| t_custom_13 | string | false | none | Telenia custom text field 13 |
| t_custom_14 | string | false | none | Telenia custom text field 14 |
| t_custom_15 | string | false | none | Telenia custom text field 15 |
| t_custom_16 | string | false | none | Telenia custom text field 16 |
| t_custom_17 | string | false | none | Telenia custom text field 17 |
| t_custom_18 | string | false | none | Telenia custom text field 18 |
| t_custom_19 | string | false | none | Telenia custom text field 19 |
| t_custom_20 | string | false | none | Telenia custom text field 20 |
| t_custom_21 | string | false | none | Telenia custom text field 21 |
| t_custom_22 | string | false | none | Telenia custom text field 22 |
| t_custom_23 | string | false | none | Telenia custom text field 23 |
| t_custom_24 | string | false | none | Telenia custom text field 24 |
| t_custom_25 | string | false | none | Telenia custom text field 25 |
| t_custom_26 | string | false | none | Telenia custom text field 26 |
| t_custom_27 | string | false | none | Telenia custom text field 27 |
| t_custom_28 | string | false | none | Telenia custom text field 28 |
| t_custom_29 | string | false | none | Telenia custom text field 29 |
| t_custom_30 | string | false | none | Telenia custom text field 30 |
| t_custom_31 | string | false | none | Telenia custom text field 31 |
| t_custom_32 | string | false | none | Telenia custom text field 32 |
| t_custom_33 | string | false | none | Telenia custom text field 33 |
| t_custom_34 | string | false | none | Telenia custom text field 34 |
| t_custom_35 | string | false | none | Telenia custom text field 35 |
| t_custom_36 | string | false | none | Telenia custom text field 36 |
| t_custom_37 | string | false | none | Telenia custom text field 37 |
| t_custom_38 | string | false | none | Telenia custom text field 38 |
| t_custom_39 | string | false | none | Telenia custom text field 39 |
| t_custom_40 | string | false | none | Telenia custom text field 40 |
| t_custom_41 | string | false | none | Telenia custom text field 41 |
| t_custom_42 | string | false | none | Telenia custom text field 42 |
| t_custom_43 | string | false | none | Telenia custom text field 43 |
| t_custom_44 | string | false | none | Telenia custom text field 44 |
| t_custom_45 | string | false | none | Telenia custom text field 45 |
| t_custom_46 | string | false | none | Telenia custom text field 46 |
| t_custom_47 | string | false | none | Telenia custom text field 47 |
| t_custom_48 | string | false | none | Telenia custom text field 48 |
| t_custom_49 | string | false | none | Telenia custom text field 49 |
| t_custom_50 | string | false | none | Telenia custom text field 50 |
| t_custom_51 | string | false | none | Telenia custom text field 51 |
| t_custom_52 | string | false | none | Telenia custom text field 52 |
| t_custom_53 | string | false | none | Telenia custom text field 53 |
| t_custom_54 | string | false | none | Telenia custom text field 54 |
| t_custom_55 | string | false | none | Telenia custom text field 55 |
| t_custom_56 | string | false | none | Telenia custom text field 56 |
| t_custom_57 | string | false | none | Telenia custom text field 57 |
| t_custom_58 | string | false | none | Telenia custom text field 58 |
| t_custom_59 | string | false | none | Telenia custom text field 59 |
| t_custom_60 | string | false | none | Telenia custom text field 60 |
| t_custom_61 | string | false | none | Telenia custom text field 61 |
| t_custom_62 | string | false | none | Telenia custom text field 62 |
| t_custom_63 | string | false | none | Telenia custom text field 63 |
| t_custom_64 | string | false | none | Telenia custom text field 64 |
| t_custom_65 | string | false | none | Telenia custom text field 65 |
| t_custom_66 | string | false | none | Telenia custom text field 66 |
| t_custom_67 | string | false | none | Telenia custom text field 67 |
| t_custom_68 | string | false | none | Telenia custom text field 68 |
| t_custom_69 | string | false | none | Telenia custom text field 69 |
| t_custom_70 | string | false | none | Telenia custom text field 70 |
| t_custom_71 | string | false | none | Telenia custom text field 71 |
| t_custom_72 | string | false | none | Telenia custom text field 72 |
| t_custom_73 | string | false | none | Telenia custom text field 73 |
| t_custom_74 | string | false | none | Telenia custom text field 74 |
| t_custom_75 | string | false | none | Telenia custom text field 75 |
| t_custom_76 | string | false | none | Telenia custom text field 76 |
| t_custom_77 | string | false | none | Telenia custom text field 77 |
| t_custom_78 | string | false | none | Telenia custom text field 78 |
| t_custom_79 | string | false | none | Telenia custom text field 79 |
| t_custom_80 | string | false | none | Telenia custom text field 80 |
| t_custom_81 | string | false | none | Telenia custom text field 81 |
| t_custom_82 | string | false | none | Telenia custom text field 82 |
| t_custom_83 | string | false | none | Telenia custom text field 83 |
| t_custom_84 | string | false | none | Telenia custom text field 84 |
| t_custom_85 | string | false | none | Telenia custom text field 85 |
| t_custom_86 | string | false | none | Telenia custom text field 86 |
| t_custom_87 | string | false | none | Telenia custom text field 87 |
| t_custom_88 | string | false | none | Telenia custom text field 88 |
| t_custom_89 | string | false | none | Telenia custom text field 89 |
| t_custom_90 | string | false | none | Telenia custom text field 90 |
| t_custom_91 | string | false | none | Telenia custom text field 91 |
| t_custom_92 | string | false | none | Telenia custom text field 92 |
| t_custom_93 | string | false | none | Telenia custom text field 93 |
| t_custom_94 | string | false | none | Telenia custom text field 94 |
| t_custom_95 | string | false | none | Telenia custom text field 95 |
| t_custom_96 | string | false | none | Telenia custom text field 96 |
| t_custom_97 | string | false | none | Telenia custom text field 97 |
| t_custom_98 | string | false | none | Telenia custom text field 98 |
| t_custom_99 | string | false | none | Telenia custom text field 99 |
| t_custom_date_01 | string(date-time) | false | none | Telenia custom date field 1 (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_custom_date_02 | string(date-time) | false | none | Telenia custom date field 2 (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_custom_date_03 | string(date-time) | false | none | Telenia custom date field 3 (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_custom_date_04 | string(date-time) | false | none | Telenia custom date field 4 (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_custom_date_05 | string(date-time) | false | none | Telenia custom date field 5 (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_custom_date_06 | string(date-time) | false | none | Telenia custom date field 6 (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_custom_date_07 | string(date-time) | false | none | Telenia custom date field 7 (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_custom_date_08 | string(date-time) | false | none | Telenia custom date field 8 (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_custom_date_09 | string(date-time) | false | none | Telenia custom date field 9 (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_custom_date_10 | string(date-time) | false | none | Telenia custom date field 10 (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_custom_date_11 | string(date-time) | false | none | Telenia custom date field 11 (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_custom_date_12 | string(date-time) | false | none | Telenia custom date field 12 (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_custom_date_13 | string(date-time) | false | none | Telenia custom date field 13 (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_custom_date_14 | string(date-time) | false | none | Telenia custom date field 14 (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_custom_date_15 | string(date-time) | false | none | Telenia custom date field 15 (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_custom_date_16 | string(date-time) | false | none | Telenia custom date field 16 (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_custom_date_17 | string(date-time) | false | none | Telenia custom date field 17 (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_custom_date_18 | string(date-time) | false | none | Telenia custom date field 18 (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_custom_date_19 | string(date-time) | false | none | Telenia custom date field 19 (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_custom_date_20 | string(date-time) | false | none | Telenia custom date field 20 (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_custom_date_21 | string(date-time) | false | none | Telenia custom date field 21 (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_custom_date_22 | string(date-time) | false | none | Telenia custom date field 22 (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_custom_date_23 | string(date-time) | false | none | Telenia custom date field 23 (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_custom_date_24 | string(date-time) | false | none | Telenia custom date field 24 (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_custom_date_25 | string(date-time) | false | none | Telenia custom date field 25 (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_custom_date_26 | string(date-time) | false | none | Telenia custom date field 26 (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_custom_date_27 | string(date-time) | false | none | Telenia custom date field 27 (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_custom_date_28 | string(date-time) | false | none | Telenia custom date field 28 (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_custom_date_29 | string(date-time) | false | none | Telenia custom date field 29 (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_custom_date_30 | string(date-time) | false | none | Telenia custom date field 30 (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_custom_date_31 | string(date-time) | false | none | Telenia custom date field 31 (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_custom_date_32 | string(date-time) | false | none | Telenia custom date field 32 (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_custom_date_33 | string(date-time) | false | none | Telenia custom date field 33 (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_custom_date_34 | string(date-time) | false | none | Telenia custom date field 34 (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_custom_date_35 | string(date-time) | false | none | Telenia custom date field 35 (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_custom_date_36 | string(date-time) | false | none | Telenia custom date field 36 (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_custom_date_37 | string(date-time) | false | none | Telenia custom date field 37 (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_custom_date_38 | string(date-time) | false | none | Telenia custom date field 38 (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_custom_date_39 | string(date-time) | false | none | Telenia custom date field 39 (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_custom_date_40 | string(date-time) | false | none | Telenia custom date field 40 (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_custom_date_41 | string(date-time) | false | none | Telenia custom date field 41 (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_custom_date_42 | string(date-time) | false | none | Telenia custom date field 42 (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_custom_date_43 | string(date-time) | false | none | Telenia custom date field 43 (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_custom_date_44 | string(date-time) | false | none | Telenia custom date field 44 (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_custom_date_45 | string(date-time) | false | none | Telenia custom date field 45 (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_custom_date_46 | string(date-time) | false | none | Telenia custom date field 46 (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_custom_date_47 | string(date-time) | false | none | Telenia custom date field 47 (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_custom_date_48 | string(date-time) | false | none | Telenia custom date field 48 (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_custom_date_49 | string(date-time) | false | none | Telenia custom date field 49 (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_external_ticketing_add | boolean | false | none | Enable ADD to external ticketing (SuiteCRM) |
| t_external_ticketing_link | string | false | none | Link to ticket on External ticketing (SuiteCRM) |
| t_forgot_article_count | integer(int32) | false | none | Copy of article count before "Oblio" procedure |
| t_forgot_time_unit | integer(int32) | false | none | Copy of time_unit*100 before "Oblio" procedure |
| t_is_child_link | boolean | false | none | Indicates whether the ticket is linked as a child of another ticket |
| t_is_forgot_ticket | boolean | false | none | Field to flag if the ticket is forgotten by "Oblio" |
| t_is_normal_link | boolean | false | none | Indicates whether the ticket is linked as a normal of another ticket |
| t_is_parent_link | boolean | false | none | Indicates whether the ticket is linked as the parent of another ticket |
| t_is_view_by_owner | boolean | false | none | Flag to mark ticket as view by owner |
| t_knowledge_base_answer_link | string | false | none | Link to the KnowledgeBase response associated with the ticket |
| t_knowledge_base_answer_uid | string | false | none | uid of the KnowledgeBase response associated with the ticket |
| t_knowledge_base_category_link | string | false | none | Link of the KnowledgeBase category associated with the ticket |
| t_knowledge_base_category_uid | string | false | none | uid of the KnowledgeBase category associated with the ticket |
| t_knowledge_base_id_answer | string | false | none | Knowledge Base Id for the answer associated with the ticket |
| t_knowledge_base_id_category | string | false | none | Knowledge Base Id for the category associated with the ticket |
| t_last_link_child_update | string | false | none | Indicates the number of the last child ticket that has undergone changes |
| t_last_link_normal_update | string | false | none | Indicates the number of the last related ticket that has undergone changes |
| t_last_link_with | string | false | none | Ticket number with which the last link was executed/canceled |
| t_last_merge_with | string | false | none | Ticket number with which the last merge was performed |
| t_last_owner_view_at | string(date-time) | false | none | Last owner view of ticket (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_queue_type | string | false | none | Queue type ACD or PICKUP |
| t_reminder_cp_last_time | string(date-time) | false | none | Datetime of last reminder from Customer Portal (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_reminder_cp_num | integer(int32) | false | none | Number of reminder from Customer Portal |
| t_reminder_tk_last_time | string(date-time) | false | none | Datetime of last reminder from Call/Ticket (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| t_reminder_tk_num | integer(int32) | false | none | Number of reminder by ticket ( ticket generati da chiamata o altri ticket) |
| t_reminder_tk_src | string | false | none | Numero e id del ticket di cui il ticket funge da sollecito nel fomrmato [num_id] |
| t_self_generated_ticket_call_final_state | string | false | none | Final state of call that generated ticket. |
| t_self_generated_ticket_type | string | false | none | Type of self generated ticket. Valori possibili: null (default) = non è un autogenerato (ticket classico), R_CALL = Reminder by CALL, R_CP = Reminder by CP, R_AGENT = Reminder by Agent, R_NS = Ticket non significativo |
| t_social_message_uid | string | false | none | Id del POST social (Facebook ad es.) associato al ticket. Con il t_social_message_uid sarà poi possibile ricavare il ticket a cui associare i commenti al POST |
| t_state_last_update | string(date-time) | false | none | Datetime of last state update (yyyy-MM-dd'T'HH:mm:ss.SSSXXX) |
| ticket_time_accounting | [string] | false | none | Ticket time accounting |
| ticket_time_accounting_ids | [integer] | false | none | Ticket time accounting ids |
| time_unit | number(float) | false | none | Accounted time units for this ticket |
| title | string | false | none | Ticket title |
| type | string | false | none | Ticket Type (deprecated) |
| update_diff_in_min | integer(int32) | false | none | Business hours in minutes within or above the specified SLA for updating the ticket |
| update_escalation_at | string(date-time) | false | none | Time stamp of the last update reaction to the customer (DateTime, UTC) |
| update_in_min | integer(int32) | false | none | Business hours in minutes it took to send the last update response to customer |
| updated_at | string(date-time) | false | none | Last update timestamp (DateTime, UTC) |
| updated_by | string | false | none | User who updated the ticket |
| updated_by_id | integer(int32) | false | none | User id of user who updated the ticket |
Enumerated Values
| Property | Value |
|---|---|
| priority | 1 low |
| priority | 2 normal |
| priority | 3 high |
| state | new |
| state | open |
| state | pending reminder |
| state | closed |
| state | merged |
| state | removed |
| state | pending close |
Trunk
Properties
{
"dtoStatus": "DELETED",
"host": "string",
"name": "string",
"ownerPanels": [
"string"
],
"status": "UNKNOWN",
"type": "SIP"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| dtoStatus | string | false | none | none |
| host | string | false | none | none |
| name | string | false | none | none |
| ownerPanels | [string] | false | none | none |
| status | string | false | none | none |
| type | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| dtoStatus | DELETED |
| dtoStatus | NEW |
| dtoStatus | MODIFIED |
| status | UNKNOWN |
| status | UNREGISTERED |
| status | LAGGED |
| status | UNMONITORED |
| status | UNREACHABLE |
| status | REGISTERED |
| status | REACHABLE |
| type | SIP |
| type | IAX2 |
| type | ENUM |
| type | UNKNOWN |
UCConfiguration
UC configuration
Properties
{
"chatEnabled": true,
"externalLookupEnabled": true,
"meetingCreatePermission": {
"defaultValue": true,
"enableDefault": true,
"value": true
},
"outlookPluginEnabled": true,
"persistentInteractionsEnabled": true,
"personalAddressbookEnabled": {
"defaultValue": true,
"enableDefault": true,
"value": true
},
"presenceActive": true,
"roomsVisibilityEnabled": true,
"sendingSMSEnabled": true,
"visible": true
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| chatEnabled | boolean | false | none | Chat enabled |
| externalLookupEnabled | boolean | false | none | External lookup enabled |
| meetingCreatePermission | ValueBoolean | false | none | WebClient log value |
| outlookPluginEnabled | boolean | false | none | Outlook Plugin Enabled |
| persistentInteractionsEnabled | boolean | false | none | Persistent interactions enabled |
| personalAddressbookEnabled | ValueBoolean | false | none | WebClient log value |
| presenceActive | boolean | false | none | Presence active |
| roomsVisibilityEnabled | boolean | false | none | Room visibility enabled |
| sendingSMSEnabled | boolean | false | none | SMS sending enabled |
| visible | boolean | false | none | Visible |
UnreachableSlaveException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
]
}
None
UserAutomatedAttendant
TVox User for Automated Attendant
Properties
{
"automatedAttendantConsoleServiceExten": "string",
"exten": "string",
"name": "string",
"publicUsername": "string",
"surname": "string",
"userAvailable": true,
"username": "string"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| automatedAttendantConsoleServiceExten | string | false | none | Automated Attendant Console service exten |
| exten | string | false | none | Exten |
| name | string | false | none | Name |
| publicUsername | string | false | none | Username |
| surname | string | false | none | Surname |
| userAvailable | boolean | false | none | User available status |
| username | string | false | none | User id |
UserClassConfigurationPermission
User class configuration permission
Properties
{
"callFowardSettings": {
"property1": {
"actionInCalendar": "DEFAULT",
"actionOutCalendar": "DEFAULT",
"calendarEnable": "DEFAULT",
"context": "ENABLE_FROM_PHONE",
"notifyCallLost": "DEFAULT",
"permission": "DEFAULT",
"ringTimeInCalendar": "DEFAULT",
"ringTimeOutCalendar": "DEFAULT",
"status": "DEFAULT"
},
"property2": {
"actionInCalendar": "DEFAULT",
"actionOutCalendar": "DEFAULT",
"calendarEnable": "DEFAULT",
"context": "ENABLE_FROM_PHONE",
"notifyCallLost": "DEFAULT",
"permission": "DEFAULT",
"ringTimeInCalendar": "DEFAULT",
"ringTimeOutCalendar": "DEFAULT",
"status": "DEFAULT"
}
},
"conference": {
"adminpin": "DEFAULT",
"closeByAdminHangupEnabled": "DEFAULT",
"countPresentMembersEnabled": "DEFAULT",
"enable": "DEFAULT",
"greetingMsg": "DEFAULT",
"musicOnHoldEnabled": "DEFAULT",
"name": "DEFAULT",
"notifyAccessEnabled": "DEFAULT",
"notifyTone": "DEFAULT",
"number": "DEFAULT",
"permission": "DEFAULT",
"userAnnounceEnabled": "DEFAULT",
"userpin": "DEFAULT",
"volMenuEnabled": "DEFAULT",
"waitAdmin": "DEFAULT"
},
"description": "string",
"directory": {
"customFields": {
"property1": "DEFAULT",
"property2": "DEFAULT"
},
"email": "DEFAULT",
"fax": "DEFAULT",
"homePhone": "DEFAULT",
"mobilePhone": "DEFAULT",
"otherPhone": "DEFAULT",
"permission": "DEFAULT"
},
"faxes": "DEFAULT",
"idTVox": 0,
"name": "DEFAULT",
"password": "DEFAULT",
"permission": "DEFAULT",
"pinForPhoneServices": "DEFAULT",
"surname": "DEFAULT",
"username": "DEFAULT",
"voicemail": {
"maxmsg": "DEFAULT",
"password": "DEFAULT",
"permission": "DEFAULT",
"toAttachFile": "DEFAULT",
"toDeleteFile": "DEFAULT",
"toSendEmail": "DEFAULT"
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| callFowardSettings | object | false | none | Call Forward settings |
| » additionalProperties | CallFowardConfigurationPermission | false | none | Call Forward settings |
| conference | ConferenceConfigurationPermission | false | none | Conference |
| description | string | false | none | Description |
| directory | DirectoryFieldsConfigurationPermission | false | none | Directory fields |
| faxes | string | false | none | Faxes |
| idTVox | integer(int32) | false | none | TVox id |
| name | string | false | none | Name |
| password | string | false | none | Password |
| permission | string | false | none | none |
| pinForPhoneServices | string | false | none | PIN for phone services |
| surname | string | false | none | Surname |
| username | string | false | none | Username |
| voicemail | VoicemailConfigurationPermission | false | none | Voicemail |
Enumerated Values
| Property | Value |
|---|---|
| faxes | DEFAULT |
| faxes | NONE |
| faxes | READ |
| faxes | READ_WRITE |
| faxes | READ_ADD |
| faxes | READ_WRITE_ADD |
| name | DEFAULT |
| name | NONE |
| name | READ |
| name | READ_WRITE |
| name | READ_ADD |
| name | READ_WRITE_ADD |
| password | DEFAULT |
| password | NONE |
| password | READ |
| password | READ_WRITE |
| password | READ_ADD |
| password | READ_WRITE_ADD |
| permission | DEFAULT |
| permission | NONE |
| permission | READ |
| permission | READ_WRITE |
| permission | READ_ADD |
| permission | READ_WRITE_ADD |
| pinForPhoneServices | DEFAULT |
| pinForPhoneServices | NONE |
| pinForPhoneServices | READ |
| pinForPhoneServices | READ_WRITE |
| pinForPhoneServices | READ_ADD |
| pinForPhoneServices | READ_WRITE_ADD |
| surname | DEFAULT |
| surname | NONE |
| surname | READ |
| surname | READ_WRITE |
| surname | READ_ADD |
| surname | READ_WRITE_ADD |
| username | DEFAULT |
| username | NONE |
| username | READ |
| username | READ_WRITE |
| username | READ_ADD |
| username | READ_WRITE_ADD |
UserCurrentDevices
User current devices
Properties
{
"clientVersion": "string",
"platform": "WEB"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| clientVersion | string | false | none | Client version |
| platform | string | false | none | Platform |
Enumerated Values
| Property | Value |
|---|---|
| platform | WEB |
| platform | IOS |
| platform | ANDROID |
| platform | EXE |
| platform | DEFAULT |
UserDetail
User
Properties
{
"callBackNumbers": [
"string"
],
"callFowardSettings": {
"property1": {
"actionInCalendar": {
"actionToDo": "DIAL"
},
"actionOutCalendar": {
"actionToDo": "DIAL"
},
"calendarEnable": true,
"context": "ENABLE_FROM_PHONE",
"extendedCallFowardFuncInCalendar": {
"alternativeAccessCode": "string",
"alternativeNumber": "string",
"alternativeNumberRingTime": 0,
"confirmRequired": true,
"notifyCallFile": {
"content": "string",
"duration": 0,
"erasable": true,
"file": "string",
"musicOnHold": true,
"name": "string",
"producedByTTS": true,
"ttsLanguage": "string",
"ttsProfile": "string",
"ttsType": "string",
"ttsVoice": "string"
},
"notifyCallLost": "EMAIL",
"twinMode": true
},
"extendedCallFowardFuncOutCalendar": {
"alternativeAccessCode": "string",
"alternativeNumber": "string",
"alternativeNumberRingTime": 0,
"confirmRequired": true,
"notifyCallFile": {
"content": "string",
"duration": 0,
"erasable": true,
"file": "string",
"musicOnHold": true,
"name": "string",
"producedByTTS": true,
"ttsLanguage": "string",
"ttsProfile": "string",
"ttsType": "string",
"ttsVoice": "string"
},
"notifyCallLost": "EMAIL",
"twinMode": true
},
"notifyCallLost": "EMAIL",
"ringTimeInCalendar": 0,
"ringTimeOutCalendar": 0,
"status": "ENABLE_ALL"
},
"property2": {
"actionInCalendar": {
"actionToDo": "DIAL"
},
"actionOutCalendar": {
"actionToDo": "DIAL"
},
"calendarEnable": true,
"context": "ENABLE_FROM_PHONE",
"extendedCallFowardFuncInCalendar": {
"alternativeAccessCode": "string",
"alternativeNumber": "string",
"alternativeNumberRingTime": 0,
"confirmRequired": true,
"notifyCallFile": {
"content": "string",
"duration": 0,
"erasable": true,
"file": "string",
"musicOnHold": true,
"name": "string",
"producedByTTS": true,
"ttsLanguage": "string",
"ttsProfile": "string",
"ttsType": "string",
"ttsVoice": "string"
},
"notifyCallLost": "EMAIL",
"twinMode": true
},
"extendedCallFowardFuncOutCalendar": {
"alternativeAccessCode": "string",
"alternativeNumber": "string",
"alternativeNumberRingTime": 0,
"confirmRequired": true,
"notifyCallFile": {
"content": "string",
"duration": 0,
"erasable": true,
"file": "string",
"musicOnHold": true,
"name": "string",
"producedByTTS": true,
"ttsLanguage": "string",
"ttsProfile": "string",
"ttsType": "string",
"ttsVoice": "string"
},
"notifyCallLost": "EMAIL",
"twinMode": true
},
"notifyCallLost": "EMAIL",
"ringTimeInCalendar": 0,
"ringTimeOutCalendar": 0,
"status": "ENABLE_ALL"
}
},
"conference": {
"adminpin": "string",
"chooseLanguageEnable": true,
"closeByAdminHangupEnabled": true,
"countPresentMembersEnabled": true,
"enable": true,
"greetingMsg": {
"content": "string",
"duration": 0,
"erasable": true,
"file": "string",
"musicOnHold": true,
"name": "string",
"producedByTTS": true,
"ttsLanguage": "string",
"ttsProfile": "string",
"ttsType": "string",
"ttsVoice": "string"
},
"language": "IT",
"musicOnHoldEnabled": true,
"name": "string",
"notifyAccessEnabled": true,
"notifyTone": true,
"number": "string",
"ownerUser": "string",
"publicNumber": true,
"userAnnounceEnabled": true,
"userpin": "string",
"volMenuEnabled": true,
"waitAdmin": true
},
"directory": {
"customCli": "string",
"customCliType": "CUST",
"customFields": {
"property1": "string",
"property2": "string"
},
"email": "string",
"fax": "string",
"homePhone": "string",
"mobilePhone": "string",
"otherPhone": "string"
},
"faxes": [
{
"administrator": true,
"fax": {
"identifier": 0,
"name": "string"
},
"receiving": "MAIL",
"receivingEnabled": true,
"sending": "MAIL",
"sendingEnabled": true
}
],
"name": "string",
"number": "string",
"pinForPhoneServices": "string",
"profiles": [
{
"abilitazioneProfile": {
"descrizione": "string",
"id": 0
},
"filtroProfile": {
"descrizione": "string",
"id": 0
},
"id": 0,
"label": "string",
"maxCallInbound": 0,
"recNoticeEnabled": true,
"registration": "DISABLED",
"tvoxStatus": "READY",
"type": "UC",
"username": "string"
}
],
"publicUsername": "string",
"sessionId": "string",
"status": "UNKNOWN",
"supervisor": true,
"surname": "string",
"ucConf": {
"chatEnabled": true,
"externalLookupEnabled": true,
"meetingCreatePermission": {
"defaultValue": true,
"enableDefault": true,
"value": true
},
"outlookPluginEnabled": true,
"persistentInteractionsEnabled": true,
"personalAddressbookEnabled": {
"defaultValue": true,
"enableDefault": true,
"value": true
},
"presenceActive": true,
"roomsVisibilityEnabled": true,
"sendingSMSEnabled": true,
"visible": true
},
"username": "string",
"voicemail": {
"language": "IT",
"maxmsg": 0,
"password": "string",
"toAttachFile": true,
"toDeleteFile": true,
"toSendEmail": true,
"uniqueid": 0
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| callBackNumbers | [string] | false | none | Callback numbers |
| callFowardSettings | object | false | none | Call Forward settings |
| » additionalProperties | CallFoward | false | none | Call Forward |
| conference | Conference | false | none | Conference |
| directory | DirectoryFields | false | none | Directory fields |
| faxes | [FaxBoxUser] | false | none | Faxes |
| name | string | false | none | Name |
| number | string | false | none | Number |
| pinForPhoneServices | string | false | none | PIN for phone services |
| profiles | [Profili] | false | none | Profiles |
| publicUsername | string | false | none | Username |
| sessionId | string | false | none | Session ID (if logged) |
| status | string | false | none | Logged status |
| supervisor | boolean | false | none | Supervisor |
| surname | string | false | none | Surname |
| ucConf | UCConfiguration | false | none | UC configuration |
| username | string | false | none | User id |
| voicemail | Voicemail | false | none | Voicemail |
Enumerated Values
| Property | Value |
|---|---|
| status | UNKNOWN |
| status | LOGGED |
| status | NOTLOGGED |
| status | RETRY |
UserDevice
User device
Properties
{
"chosenByClient": true,
"extension": "string",
"owner": {
"defaultCallableNumber": "string",
"name": "string",
"publicUsername": "string",
"surname": "string",
"username": "string"
},
"rec": "AUT",
"registrationStatus": {
"ipAddress": "string",
"status": "REGISTERED",
"userAgent": "string"
},
"smartWorkingEnabled": true,
"type": "WEB"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| chosenByClient | boolean | false | none | Chosen by client |
| extension | string | false | none | Extension |
| owner | UserDeviceUser | false | none | Device user |
| rec | string | false | none | Device recording |
| registrationStatus | UserDeviceRegistrationStatus | false | none | Device registration status |
| smartWorkingEnabled | boolean | false | none | SmartWorking enabled |
| type | string | false | none | Type |
Enumerated Values
| Property | Value |
|---|---|
| rec | AUT |
| rec | ON |
| rec | OFF |
| rec | PER |
| rec | PROBABLY |
| type | WEB |
| type | APP |
| type | SIP |
| type | EXTERNAL |
UserDeviceRegistrationStatus
Device registration status
Properties
{
"ipAddress": "string",
"status": "REGISTERED",
"userAgent": "string"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| ipAddress | string | false | none | IP address |
| status | string | false | none | Status value |
| userAgent | string | false | none | User agent |
Enumerated Values
| Property | Value |
|---|---|
| status | REGISTERED |
| status | REACHABLE |
| status | LAGGED |
| status | UNREGISTERED |
| status | UNREACHABLE |
| status | UNMONITORED |
| status | UNKNOWN |
UserDeviceUser
Device user
Properties
{
"defaultCallableNumber": "string",
"name": "string",
"publicUsername": "string",
"surname": "string",
"username": "string"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| defaultCallableNumber | string | false | none | Default callable number |
| name | string | false | none | Name |
| publicUsername | string | false | none | Username |
| surname | string | false | none | Surname |
| username | string | false | none | User id |
UserInboundRoute
User inbound route
Properties
{
"bpmId": 0,
"calledNumber": "string",
"calledNumberRegExp": true,
"callerNumber": "string",
"callerNumberRegExp": true,
"description": "string",
"disaEnable": true,
"disaRetry": 0,
"followCalendar": "ENABLED",
"id": 0,
"name": "string",
"serviceType": "IVR",
"type": "USER",
"value": "string"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| bpmId | integer(int32) | false | none | BPM id |
| calledNumber | string | false | none | Called number |
| calledNumberRegExp | boolean | false | none | Called number regular expression |
| callerNumber | string | false | none | Caller number |
| callerNumberRegExp | boolean | false | none | none |
| description | string | false | none | Description |
| disaEnable | boolean | false | none | Disa enabled |
| disaRetry | integer(int32) | false | none | Disa retry |
| followCalendar | string | false | none | Follow calendar enabled |
| id | integer(int32) | false | none | Id |
| name | string | false | none | Name |
| serviceType | ServiceType | false | none | Service type |
| type | string | false | none | Type |
| value | string | false | none | Value |
Enumerated Values
| Property | Value |
|---|---|
| followCalendar | ENABLED |
| followCalendar | DISABLED |
| followCalendar | DEFAULT |
| type | USER |
| type | FAX |
| type | SERVICE |
| type | SERVICE_CODE |
| type | NUMBER |
| type | CONFERENCEROOM |
| type | HANGUP |
| type | BUSY |
| type | CONGESTION |
UserOfGeneric
Properties
{
"description": "string",
"id": "string",
"type": "MOH"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| description | string | false | none | none |
| id | string | false | none | none |
| type | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| type | MOH |
| type | REC |
| type | SERVICE |
| type | SERVICE_CODE |
| type | SKILLSET |
| type | SKILLSET_SCHEDULE |
| type | ADS_ALARM |
| type | ADS_ALARM_LIST |
| type | CONFERENCE |
| type | CONFERENCE_USER |
| type | PARK |
| type | MOBILITY |
| type | IVR |
| type | IVR_NODE |
| type | USER |
| type | EXTEN |
| type | FAX |
| type | UNKNOWN |
| type | UC_DIRETTORE |
| type | UC_ASSESSORE |
| type | UC_SEGRETARIA |
| type | QUALITY_INTERVIEW |
| type | INBOUND_RULE |
| type | OUTBOUND_RULE |
| type | EMAIL_BOX |
| type | CALLRESULT_CODE |
| type | SWITCH_TO_GSM_HOLD |
| type | ABILITAZIONE_CALL |
| type | EMERGENCY_NUMBERS |
| type | SITE |
| type | TRUNK |
| type | GENERIC_PARAM |
| type | PICKUP_GROUP |
| type | SHORT_NUMBER |
| type | SLA |
| type | WIDGET |
| type | POWERDIALER_CAMPAIGN |
| type | EXTERNAL_ACCOUNT |
| type | EXTERNAL_ACCOUNT_PHONE |
| type | MEETING |
| type | TCONSOLE_BLFSERVER |
| type | SUPPORT_CUSTOM_FIELD |
| type | BPM_PROCESS |
| type | SURVEY |
| type | FUNCTION |
| type | VIRTUAL_AGENT |
| type | APPLICATION |
| type | ADDRESSBOOK_PERSONAL |
| type | ALIAS |
UserPermission
Properties
"SUPERUSER"
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | SUPERUSER |
| anonymous | SYSTEM_ADMIN |
| anonymous | SUPERVISOR |
| anonymous | UC_USERS |
| anonymous | UC_SERVICES |
| anonymous | UC_GROUP |
| anonymous | CC_USERS |
| anonymous | CC_SERVICES |
| anonymous | CC_SKILLSET |
| anonymous | ADDRESSBOOK |
| anonymous | ACTIVITY_CODES |
| anonymous | CALL_RESULTS |
| anonymous | SURVEY |
| anonymous | AUDIO |
| anonymous | POPUP_MANAGER |
| anonymous | MAIL_CHANNEL |
| anonymous | FACEBOOK_CHANNEL |
| anonymous | TWITTER_CHANNEL |
| anonymous | TELEGRAM_CHANNEL |
| anonymous | IVR |
| anonymous | DEVICES |
| anonymous | DIALPLAN_ROUTING |
| anonymous | SHORT_NUMBERS |
| anonymous | CONFERENCE |
| anonymous | PICKUP_GROUPS |
| anonymous | FAX |
| anonymous | ADVANCED_SETTINGS |
| anonymous | EMAIL_SETTINGS |
| anonymous | WIDGET |
| anonymous | CALENDAR |
| anonymous | GRTD |
| anonymous | CALL_NAVIGATOR |
| anonymous | DOWNLOAD_FILE_AUDIO_RECORDED |
| anonymous | CHAT_NAVIGATOR |
| anonymous | TICKET_NAVIGATOR |
| anonymous | LIVE_HELP_NAVIGATOR |
| anonymous | VIDEO_NAVIGATOR |
| anonymous | SEND_ADMIN_CHAT |
| anonymous | RESET_PASSWORD |
| anonymous | CHANSPY |
| anonymous | KNOWLEDGEBASE_READ |
| anonymous | KNOWLEDGEBASE_WRITE |
| anonymous | SUPPORT_EMAIL_FILTER |
| anonymous | REPORT_EXPORT |
| anonymous | CUSTOM_CHANNEL_NAVIGATOR |
| anonymous | INTRANET_CONFIG |
| anonymous | REPORT_MULTICHANNEL_AGENT |
| anonymous | TVOX_UPGRADE |
| anonymous | INSIGHT |
| anonymous | SYSTEM_MONITOR |
| anonymous | BPMN |
| anonymous | CUSTOMER_PORTAL_ADMIN |
| anonymous | CDR |
| anonymous | CAMPAIGN_MANAGER |
UserSite
User site
Properties
{
"cliCallForwardEnabled": true,
"id": 0,
"name": "string"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| cliCallForwardEnabled | boolean | false | none | CLI Call Forward enabled |
| id | integer(int32) | false | none | Id |
| name | string | false | none | Name |
UsersImportCheckError
Properties
{
"cause": "string",
"code": {},
"row": 0,
"sheet": "string"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| cause | string | false | none | none |
| code | object | false | none | none |
| row | integer(int32) | false | none | none |
| sheet | string | false | none | none |
UsersImportCheckResult
Properties
{
"errors": [
{}
],
"totalDevice": 0,
"totalUsers": 0
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| errors | [object] | false | none | none |
| totalDevice | integer(int32) | false | none | none |
| totalUsers | integer(int32) | false | none | none |
UsersImportError
Properties
{
"errors": [
{}
],
"index": 0,
"username": "string"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| errors | [object] | false | none | none |
| index | integer(int32) | false | none | none |
| username | string | false | none | none |
UsersImportRequest
Properties
{
"startIndex": 0,
"usersToImport": 0
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| startIndex | integer(int32) | false | none | none |
| usersToImport | integer(int32) | false | none | none |
UsersImportResult
Properties
{
"checkerrors": [
{
"cause": "string",
"code": {},
"row": 0,
"sheet": "string"
}
],
"errors": [
{
"errors": [
{}
],
"index": 0,
"username": "string"
}
],
"tot": 0,
"users": [
{
"index": 0,
"username": "string"
}
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| checkerrors | [UsersImportCheckError] | false | none | none |
| errors | [UsersImportError] | false | none | none |
| tot | integer(int32) | false | none | none |
| users | [ImportedUser] | false | none | none |
ValueBoolean
WebClient log value
Properties
{
"defaultValue": true,
"enableDefault": true,
"value": true
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| defaultValue | boolean | false | none | Default value |
| enableDefault | boolean | false | none | Default value enabled |
| value | boolean | false | none | Current value |
ValueEnabled
DND notify value
Properties
{
"defaultValue": "ENABLED",
"enableDefault": true,
"value": "ENABLED"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| defaultValue | string | false | none | Default value |
| enableDefault | boolean | false | none | Default value enabled |
| value | string | false | none | Current value |
Enumerated Values
| Property | Value |
|---|---|
| defaultValue | ENABLED |
| defaultValue | DISABLED |
| defaultValue | DEFAULT |
| value | ENABLED |
| value | DISABLED |
| value | DEFAULT |
ValueInteger
WebClient log minutes value
Properties
{
"defaultValue": 0,
"enableDefault": true,
"value": 0
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| defaultValue | integer(int32) | false | none | Default value |
| enableDefault | boolean | false | none | Default value enabled |
| value | integer(int32) | false | none | Current value |
VisualAcuityConfiguration
Properties
{
"altF12Field": "TEL1",
"alternativeResearchFeatureExternal": "N",
"alternativeResearchFeatureInternal": "N",
"brailleFeatures": [
"on_addressbook"
],
"ctrlF12Field": "TEL1",
"instruments": [
"sv"
],
"ipoFeatures": [
"ici_top"
],
"keyToAction": {
"f10Action": "HELP",
"f11Action": "HELP",
"f12Action": "HELP",
"f1Action": "HELP",
"f2Action": "HELP",
"f3Action": "HELP",
"f4Action": "HELP",
"f5Action": "HELP",
"f6Action": "HELP",
"f7Action": "HELP",
"f8Action": "HELP",
"f9Action": "HELP"
},
"notesEnabled": true,
"phoneKeypadEnabled": true,
"shiftF12Field": "TEL1",
"showCallLookup": true,
"speedDialers": [
{
"index": 0,
"label": "string",
"value": "string"
}
],
"synthVocalFeatures": [
"on_number"
],
"themeStyleChoosen": "string",
"type": "v"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| altF12Field | string | false | none | none |
| alternativeResearchFeatureExternal | string | false | none | none |
| alternativeResearchFeatureInternal | string | false | none | none |
| brailleFeatures | [string] | false | none | none |
| ctrlF12Field | string | false | none | none |
| instruments | [string] | false | none | none |
| ipoFeatures | [string] | false | none | none |
| keyToAction | KeyToAction | false | none | none |
| notesEnabled | boolean | false | none | none |
| phoneKeypadEnabled | boolean | false | none | none |
| shiftF12Field | string | false | none | none |
| showCallLookup | boolean | false | none | none |
| speedDialers | [PoSpeedDialer] | false | none | none |
| synthVocalFeatures | [string] | false | none | none |
| themeStyleChoosen | string | false | none | none |
| type | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| altF12Field | TEL1 |
| altF12Field | TEL2 |
| altF12Field | TEL3 |
| altF12Field | TEL4 |
| altF12Field | TEL5 |
| altF12Field | TEL6 |
| altF12Field | TEL7 |
| altF12Field | TEL8 |
| altF12Field | TEL9 |
| alternativeResearchFeatureExternal | N |
| alternativeResearchFeatureExternal | FN |
| alternativeResearchFeatureExternal | ORG |
| alternativeResearchFeatureExternal | ADR |
| alternativeResearchFeatureExternal | CATEGORIES |
| alternativeResearchFeatureExternal | NOTE |
| alternativeResearchFeatureExternal | TEL |
| alternativeResearchFeatureExternal | |
| alternativeResearchFeatureExternal | URL |
| alternativeResearchFeatureExternal | RELATED |
| alternativeResearchFeatureExternal | KIND |
| alternativeResearchFeatureExternal | TELENIA_NOTE_AGENT |
| alternativeResearchFeatureExternal | TELENIA_NOTE_AGENT_LAST_UPDATE |
| alternativeResearchFeatureExternal | TELENIA_NOTE_AGENT_USER_UPDATE |
| alternativeResearchFeatureExternal | TELENIA_NOTE_AGENT_MODIFIED |
| alternativeResearchFeatureExternal | TELENIA_VCARD_ORIGIN |
| alternativeResearchFeatureExternal | TELENIA_VIP |
| alternativeResearchFeatureExternal | TELENIA_SITE |
| alternativeResearchFeatureExternal | TELENIA_ROLE |
| alternativeResearchFeatureExternal | TELENIA_CUSTOM_01 |
| alternativeResearchFeatureExternal | TELENIA_CUSTOM_02 |
| alternativeResearchFeatureExternal | TELENIA_CUSTOM_03 |
| alternativeResearchFeatureExternal | TELENIA_CUSTOM_04 |
| alternativeResearchFeatureExternal | TELENIA_CUSTOM_05 |
| alternativeResearchFeatureExternal | TELENIA_CUSTOM_06 |
| alternativeResearchFeatureExternal | TELENIA_CUSTOM_07 |
| alternativeResearchFeatureExternal | TELENIA_CUSTOM_08 |
| alternativeResearchFeatureExternal | TELENIA_CUSTOM_09 |
| alternativeResearchFeatureExternal | TELENIA_CUSTOM_10 |
| alternativeResearchFeatureExternal | TELENIA_CHANNEL_PHONE |
| alternativeResearchFeatureExternal | TELENIA_CHANNEL_CALLBACK |
| alternativeResearchFeatureExternal | TELENIA_CHANNEL_VIDEO |
| alternativeResearchFeatureExternal | TELENIA_CHANNEL_MAIL |
| alternativeResearchFeatureExternal | TELENIA_CHANNEL_MAIL_ORG |
| alternativeResearchFeatureExternal | TELENIA_CHANNEL_LIVEHELP |
| alternativeResearchFeatureExternal | TELENIA_CHANNEL_WHATSAPP_TWILIO |
| alternativeResearchFeatureExternal | TELENIA_CHANNEL_CHAT |
| alternativeResearchFeatureExternal | TELENIA_CHANNEL_1 |
| alternativeResearchFeatureExternal | TELENIA_CHANNEL_2 |
| alternativeResearchFeatureExternal | TELENIA_CHANNEL_3 |
| alternativeResearchFeatureExternal | TELENIA_BACKEND_CONFIG_NAME |
| alternativeResearchFeatureExternal | TELENIA_PERSISTENT_INTERACTIONS |
| alternativeResearchFeatureExternal | TELENIA_ACCEPT_CENSUS |
| alternativeResearchFeatureExternal | TELENIA_CUSTOMER_CODE |
| alternativeResearchFeatureExternal | TELENIA_LAST_A_TYPE |
| alternativeResearchFeatureExternal | TELENIA_NPS |
| alternativeResearchFeatureExternal | TELENIA_SOURCE_ORIGIN_TYPE |
| alternativeResearchFeatureExternal | TELENIA_PRIORITY |
| alternativeResearchFeatureExternal | TELENIA_IMPERSONAL |
| alternativeResearchFeatureExternal | TELENIA_FORGOTTEN_CONTACT |
| alternativeResearchFeatureInternal | N |
| alternativeResearchFeatureInternal | FN |
| alternativeResearchFeatureInternal | ORG |
| alternativeResearchFeatureInternal | ADR |
| alternativeResearchFeatureInternal | CATEGORIES |
| alternativeResearchFeatureInternal | NOTE |
| alternativeResearchFeatureInternal | TEL |
| alternativeResearchFeatureInternal | |
| alternativeResearchFeatureInternal | URL |
| alternativeResearchFeatureInternal | RELATED |
| alternativeResearchFeatureInternal | KIND |
| alternativeResearchFeatureInternal | TELENIA_NOTE_AGENT |
| alternativeResearchFeatureInternal | TELENIA_NOTE_AGENT_LAST_UPDATE |
| alternativeResearchFeatureInternal | TELENIA_NOTE_AGENT_USER_UPDATE |
| alternativeResearchFeatureInternal | TELENIA_NOTE_AGENT_MODIFIED |
| alternativeResearchFeatureInternal | TELENIA_VCARD_ORIGIN |
| alternativeResearchFeatureInternal | TELENIA_VIP |
| alternativeResearchFeatureInternal | TELENIA_SITE |
| alternativeResearchFeatureInternal | TELENIA_ROLE |
| alternativeResearchFeatureInternal | TELENIA_CUSTOM_01 |
| alternativeResearchFeatureInternal | TELENIA_CUSTOM_02 |
| alternativeResearchFeatureInternal | TELENIA_CUSTOM_03 |
| alternativeResearchFeatureInternal | TELENIA_CUSTOM_04 |
| alternativeResearchFeatureInternal | TELENIA_CUSTOM_05 |
| alternativeResearchFeatureInternal | TELENIA_CUSTOM_06 |
| alternativeResearchFeatureInternal | TELENIA_CUSTOM_07 |
| alternativeResearchFeatureInternal | TELENIA_CUSTOM_08 |
| alternativeResearchFeatureInternal | TELENIA_CUSTOM_09 |
| alternativeResearchFeatureInternal | TELENIA_CUSTOM_10 |
| alternativeResearchFeatureInternal | TELENIA_CHANNEL_PHONE |
| alternativeResearchFeatureInternal | TELENIA_CHANNEL_CALLBACK |
| alternativeResearchFeatureInternal | TELENIA_CHANNEL_VIDEO |
| alternativeResearchFeatureInternal | TELENIA_CHANNEL_MAIL |
| alternativeResearchFeatureInternal | TELENIA_CHANNEL_MAIL_ORG |
| alternativeResearchFeatureInternal | TELENIA_CHANNEL_LIVEHELP |
| alternativeResearchFeatureInternal | TELENIA_CHANNEL_WHATSAPP_TWILIO |
| alternativeResearchFeatureInternal | TELENIA_CHANNEL_CHAT |
| alternativeResearchFeatureInternal | TELENIA_CHANNEL_1 |
| alternativeResearchFeatureInternal | TELENIA_CHANNEL_2 |
| alternativeResearchFeatureInternal | TELENIA_CHANNEL_3 |
| alternativeResearchFeatureInternal | TELENIA_BACKEND_CONFIG_NAME |
| alternativeResearchFeatureInternal | TELENIA_PERSISTENT_INTERACTIONS |
| alternativeResearchFeatureInternal | TELENIA_ACCEPT_CENSUS |
| alternativeResearchFeatureInternal | TELENIA_CUSTOMER_CODE |
| alternativeResearchFeatureInternal | TELENIA_LAST_A_TYPE |
| alternativeResearchFeatureInternal | TELENIA_NPS |
| alternativeResearchFeatureInternal | TELENIA_SOURCE_ORIGIN_TYPE |
| alternativeResearchFeatureInternal | TELENIA_PRIORITY |
| alternativeResearchFeatureInternal | TELENIA_IMPERSONAL |
| alternativeResearchFeatureInternal | TELENIA_FORGOTTEN_CONTACT |
| ctrlF12Field | TEL1 |
| ctrlF12Field | TEL2 |
| ctrlF12Field | TEL3 |
| ctrlF12Field | TEL4 |
| ctrlF12Field | TEL5 |
| ctrlF12Field | TEL6 |
| ctrlF12Field | TEL7 |
| ctrlF12Field | TEL8 |
| ctrlF12Field | TEL9 |
| shiftF12Field | TEL1 |
| shiftF12Field | TEL2 |
| shiftF12Field | TEL3 |
| shiftF12Field | TEL4 |
| shiftF12Field | TEL5 |
| shiftF12Field | TEL6 |
| shiftF12Field | TEL7 |
| shiftF12Field | TEL8 |
| shiftF12Field | TEL9 |
| type | v |
| type | nv |
| type | ipo |
Voicemail
Voicemail
Properties
{
"language": "IT",
"maxmsg": 0,
"password": "string",
"toAttachFile": true,
"toDeleteFile": true,
"toSendEmail": true,
"uniqueid": 0
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| language | Language | false | none | Language |
| maxmsg | integer(int32) | false | none | Max messages |
| password | string | false | none | Password |
| toAttachFile | boolean | false | none | Attach file enabled |
| toDeleteFile | boolean | false | none | Delete file enabled |
| toSendEmail | boolean | false | none | Email send enabled |
| uniqueid | integer(int32) | false | none | Unique ID |
VoicemailConfigurationPermission
Voicemail
Properties
{
"maxmsg": "DEFAULT",
"password": "DEFAULT",
"permission": "DEFAULT",
"toAttachFile": "DEFAULT",
"toDeleteFile": "DEFAULT",
"toSendEmail": "DEFAULT"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| maxmsg | string | false | none | none |
| password | string | false | none | none |
| permission | string | false | none | none |
| toAttachFile | string | false | none | none |
| toDeleteFile | string | false | none | none |
| toSendEmail | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| maxmsg | DEFAULT |
| maxmsg | NONE |
| maxmsg | READ |
| maxmsg | READ_WRITE |
| maxmsg | READ_ADD |
| maxmsg | READ_WRITE_ADD |
| password | DEFAULT |
| password | NONE |
| password | READ |
| password | READ_WRITE |
| password | READ_ADD |
| password | READ_WRITE_ADD |
| permission | DEFAULT |
| permission | NONE |
| permission | READ |
| permission | READ_WRITE |
| permission | READ_ADD |
| permission | READ_WRITE_ADD |
| toAttachFile | DEFAULT |
| toAttachFile | NONE |
| toAttachFile | READ |
| toAttachFile | READ_WRITE |
| toAttachFile | READ_ADD |
| toAttachFile | READ_WRITE_ADD |
| toDeleteFile | DEFAULT |
| toDeleteFile | NONE |
| toDeleteFile | READ |
| toDeleteFile | READ_WRITE |
| toDeleteFile | READ_ADD |
| toDeleteFile | READ_WRITE_ADD |
| toSendEmail | DEFAULT |
| toSendEmail | NONE |
| toSendEmail | READ |
| toSendEmail | READ_WRITE |
| toSendEmail | READ_ADD |
| toSendEmail | READ_WRITE_ADD |
WebAPIException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
]
}
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| cause | object | false | none | none |
| » localizedMessage | string | false | none | none |
| » message | string | false | none | none |
| » stackTrace | [object] | false | none | none |
| »» className | string | false | none | none |
| »» fileName | string | false | none | none |
| »» lineNumber | integer(int32) | false | none | none |
| »» methodName | string | false | none | none |
| »» nativeMethod | boolean | false | none | none |
| » suppressed | [object] | false | none | none |
| »» localizedMessage | string | false | none | none |
| »» message | string | false | none | none |
| »» stackTrace | [object] | false | none | none |
| »»» className | string | false | none | none |
| »»» fileName | string | false | none | none |
| »»» lineNumber | integer(int32) | false | none | none |
| »»» methodName | string | false | none | none |
| »»» nativeMethod | boolean | false | none | none |
| clazz | string | true | none | none |
| code | integer(int32) | false | none | none |
| exceptionName | string | false | none | none |
| localizedMessage | string | false | none | none |
| message | string | false | none | none |
| stackTrace | [object] | false | none | none |
| » className | string | false | none | none |
| » fileName | string | false | none | none |
| » lineNumber | integer(int32) | false | none | none |
| » methodName | string | false | none | none |
| » nativeMethod | boolean | false | none | none |
| suppressed | [object] | false | none | none |
| » localizedMessage | string | false | none | none |
| » message | string | false | none | none |
| » stackTrace | [object] | false | none | none |
| »» className | string | false | none | none |
| »» fileName | string | false | none | none |
| »» lineNumber | integer(int32) | false | none | none |
| »» methodName | string | false | none | none |
| »» nativeMethod | boolean | false | none | none |
WebAPISetUserException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
]
}
None
WebTerminalBackupInProgressException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
]
}
None
WebTerminalRestoreInProgressException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
]
}
None
WebTerminalServerException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
]
}
None
WhatsAppTemplateListRequest
Properties
{
"apiKey": "string",
"limit": 0,
"number": "string",
"offset": 0,
"sid": "string"
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| apiKey | string | true | none | API Key: Unique encrypted string associated with your Kaleyra account, used to authenticate and identify the application making the API call. |
| limit | integer(int32) | false | none | none |
| number | string | true | none | WhatsApp Business number linked to the account. |
| offset | integer(int32) | false | none | none |
| sid | string | true | none | SID (Service Identifier): Unique identifier of your Kaleyra account. |
WidgetFormAddressbookFieldEnabledException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"addressbook": "string",
"channel": 0,
"className": "string",
"field": "string",
"form": {
"property1": "string",
"property2": "string"
},
"formField": {
"property1": "string",
"property2": "string"
},
"service": {
"property1": "string",
"property2": "string"
},
"value": {}
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » addressbook | string | false | none | none |
| » channel | integer(int32) | false | none | none |
| » className | string | false | none | none |
| » field | string | false | none | none |
| » form | object | false | none | none |
| »» additionalProperties | string | false | none | none |
| » formField | object | false | none | none |
| »» additionalProperties | string | false | none | none |
| » service | object | false | none | none |
| »» additionalProperties | string | false | none | none |
| » value | object | false | none | none |
WidgetFormAddressbookFieldVisibleException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"addressbook": "string",
"channel": 0,
"className": "string",
"field": "string",
"form": {
"property1": "string",
"property2": "string"
},
"formField": {
"property1": "string",
"property2": "string"
},
"service": {
"property1": "string",
"property2": "string"
},
"value": {}
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » addressbook | string | false | none | none |
| » channel | integer(int32) | false | none | none |
| » className | string | false | none | none |
| » field | string | false | none | none |
| » form | object | false | none | none |
| »» additionalProperties | string | false | none | none |
| » formField | object | false | none | none |
| »» additionalProperties | string | false | none | none |
| » service | object | false | none | none |
| »» additionalProperties | string | false | none | none |
| » value | object | false | none | none |
WidgetFormAddressbookFieldWritableException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"addressbook": "string",
"channel": 0,
"className": "string",
"field": "string",
"form": {
"property1": "string",
"property2": "string"
},
"formField": {
"property1": "string",
"property2": "string"
},
"service": {
"property1": "string",
"property2": "string"
},
"value": {}
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » addressbook | string | false | none | none |
| » channel | integer(int32) | false | none | none |
| » className | string | false | none | none |
| » field | string | false | none | none |
| » form | object | false | none | none |
| »» additionalProperties | string | false | none | none |
| » formField | object | false | none | none |
| »» additionalProperties | string | false | none | none |
| » service | object | false | none | none |
| »» additionalProperties | string | false | none | none |
| » value | object | false | none | none |
WidgetFormCheckboxValuesException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"addressbook": "string",
"channel": 0,
"className": "string",
"field": "string",
"form": {
"property1": "string",
"property2": "string"
},
"formField": {
"property1": "string",
"property2": "string"
},
"service": {
"property1": "string",
"property2": "string"
},
"value": {}
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » addressbook | string | false | none | none |
| » channel | integer(int32) | false | none | none |
| » className | string | false | none | none |
| » field | string | false | none | none |
| » form | object | false | none | none |
| »» additionalProperties | string | false | none | none |
| » formField | object | false | none | none |
| »» additionalProperties | string | false | none | none |
| » service | object | false | none | none |
| »» additionalProperties | string | false | none | none |
| » value | object | false | none | none |
WidgetFormException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"addressbook": "string",
"channel": 0,
"className": "string",
"field": "string",
"form": {
"property1": "string",
"property2": "string"
},
"formField": {
"property1": "string",
"property2": "string"
},
"service": {
"property1": "string",
"property2": "string"
},
"value": {}
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » addressbook | string | false | none | none |
| » channel | integer(int32) | false | none | none |
| » className | string | false | none | none |
| » field | string | false | none | none |
| » form | object | false | none | none |
| »» additionalProperties | string | false | none | none |
| » formField | object | false | none | none |
| »» additionalProperties | string | false | none | none |
| » service | object | false | none | none |
| »» additionalProperties | string | false | none | none |
| » value | object | false | none | none |
WidgetFormListTypeException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"addressbook": "string",
"channel": 0,
"className": "string",
"field": "string",
"form": {
"property1": "string",
"property2": "string"
},
"formField": {
"property1": "string",
"property2": "string"
},
"service": {
"property1": "string",
"property2": "string"
},
"value": {}
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » addressbook | string | false | none | none |
| » channel | integer(int32) | false | none | none |
| » className | string | false | none | none |
| » field | string | false | none | none |
| » form | object | false | none | none |
| »» additionalProperties | string | false | none | none |
| » formField | object | false | none | none |
| »» additionalProperties | string | false | none | none |
| » service | object | false | none | none |
| »» additionalProperties | string | false | none | none |
| » value | object | false | none | none |
WidgetFormLookupFieldRequiredException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"addressbook": "string",
"channel": 0,
"className": "string",
"field": "string",
"form": {
"property1": "string",
"property2": "string"
},
"formField": {
"property1": "string",
"property2": "string"
},
"service": {
"property1": "string",
"property2": "string"
},
"value": {}
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » addressbook | string | false | none | none |
| » channel | integer(int32) | false | none | none |
| » className | string | false | none | none |
| » field | string | false | none | none |
| » form | object | false | none | none |
| »» additionalProperties | string | false | none | none |
| » formField | object | false | none | none |
| »» additionalProperties | string | false | none | none |
| » service | object | false | none | none |
| »» additionalProperties | string | false | none | none |
| » value | object | false | none | none |
WidgetFormLookupFieldSearchableException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"addressbook": "string",
"channel": 0,
"className": "string",
"field": "string",
"form": {
"property1": "string",
"property2": "string"
},
"formField": {
"property1": "string",
"property2": "string"
},
"service": {
"property1": "string",
"property2": "string"
},
"value": {}
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » addressbook | string | false | none | none |
| » channel | integer(int32) | false | none | none |
| » className | string | false | none | none |
| » field | string | false | none | none |
| » form | object | false | none | none |
| »» additionalProperties | string | false | none | none |
| » formField | object | false | none | none |
| »» additionalProperties | string | false | none | none |
| » service | object | false | none | none |
| »» additionalProperties | string | false | none | none |
| » value | object | false | none | none |
WidgetFormSameListValuesException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"addressbook": "string",
"channel": 0,
"className": "string",
"field": "string",
"form": {
"property1": "string",
"property2": "string"
},
"formField": {
"property1": "string",
"property2": "string"
},
"service": {
"property1": "string",
"property2": "string"
},
"value": {}
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » addressbook | string | false | none | none |
| » channel | integer(int32) | false | none | none |
| » className | string | false | none | none |
| » field | string | false | none | none |
| » form | object | false | none | none |
| »» additionalProperties | string | false | none | none |
| » formField | object | false | none | none |
| »» additionalProperties | string | false | none | none |
| » service | object | false | none | none |
| »» additionalProperties | string | false | none | none |
| » value | object | false | none | none |
WrongSessionIdException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"newSessionId": "string",
"sessionId": "string"
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » newSessionId | string | false | none | none |
| » sessionId | string | false | none | none |
WrongVersionException
Properties
{
"cause": {
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
null
]
}
]
},
"clazz": "string",
"code": 0,
"exceptionName": "string",
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": "string",
"fileName": "string",
"lineNumber": 0,
"methodName": "string",
"nativeMethod": true
}
],
"suppressed": [
{
"localizedMessage": "string",
"message": "string",
"stackTrace": [
{
"className": null,
"fileName": null,
"lineNumber": null,
"methodName": null,
"nativeMethod": null
}
]
}
],
"sessionId": "string",
"versionRequired": "string"
}
allOf - discriminator: WebAPIException.clazz
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | WebAPIException | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » sessionId | string | false | none | none |
| » versionRequired | string | false | none | none |
Changelog
1.6.1
Available from: 26.4.1, 26.5.0
- Features / Enhancements
- Power Dialer > Add list items (contacts) for call channel: Added new field
contactPriorityto PDInterfaceItem to specify priority level of the contact within the list. Lower values are processed first. Default value is 1, minimum value is 1.
- Power Dialer > Add list items (contacts) for call channel: Added new field
1.6.0
Available from: 26.4.0
- Features / Enhancements
- TVox Users Management > Search users with automated attendant feature enabled: Added possibility to search users with automated attendant feature enabled
1.5.0
Available from: 26.3.0
- Breaking Changes
- Power Dialer > Delete list items (contacts): The API response structure and semantics have changed. The PDInterfaceItem object now includes a new field
deleteResult, indicating the result of the delete operation (DELETED,MARKED_TO_DELETE,NOT_FOUND). Previously, the API returned only the contacts that were successfully deleted. The response now includes all requested contacts, each with its corresponding delete outcome.
- Power Dialer > Delete list items (contacts): The API response structure and semantics have changed. The PDInterfaceItem object now includes a new field
1.4.1
Available from: 24.9.16, 26.2.1
- Features / Enhancements
- User devices > Get user devices: Added possibility to filter by device in use on client
1.4.0
Available from: 24.5.0
- Features / Enhancements
- General documentation improvements
- Power Dialer > Add list to campaign: Added method to add one or more lists to campaign
- Power Dialer > Remove list from campaign: Added method to remove one or more lists from campaign
- Power Dialer > Delete list by name for call campaigns: Added method to delete list by name
- Power Dialer > Campaign id and list id are no longer required for creating campaigns and lists
- Power Dialer > Removed the following deprecated properties from PDList:
voicemailAttempts,voicemailEnabled,voicemailTimeout - TVox Users Management > Acquire exten by pin: Added method to acquire exten on user by pin
- TVox Users Management > Force logout of agent: Added method to logout agent
- TVox Users Management > Get username by pin: Added method to get username of the user by pin
- TVox Users Management > Get user: Added method to get TVox user
- User devices > Get user devices: Added method to get user devices
1.3.1
Available from: 24.3.0
- Features / Enhancements
- Phone channel - Call > Added new methods to record calls (start and stop) and get user's service calls
1.3.0
Available from: 24.3.0
- Features / Enhancements
- Power Dialer > Add list items (contacts): Added scheduled date from which the contact is to be called (
scheduledDate) - Chat > List chat session messages: Now you can list chat session messages by chat session id
- Power Dialer > Add list items (contacts): Added scheduled date from which the contact is to be called (
1.2.0
Available from: 22.2.0, 24.3.0
- Features / Enhancements
- Power Dialer >: Now you can manage instant messaging campaings, start/stop runs for them and filter these runs by campaign
- Power Dialer >: Removed
/phonefrom requests' endpoints
1.1.3
Available from: 22.0.33, 22.1.11, 22.2.7, 22.3.6, 24.3.0
- Features / Enhancements
- SMS >: Now you can send SMS from specific enabled user to any number
1.1.2
Available from: 22.0.29, 22.1.10, 22.2.6, 22.3.4, 24.3.0
- Features / Enhancements
- Support channel - Ticket > Search tickets: Now you can search tickets by agents and customers
- Support channel - Ticket > Added new methods to get customers and agents list
1.1.1
Available from: 22.0.23, 22.1.7, 22.2.5, 22.3.3, 24.3.0
- Features / Enhancements
- Support channel - Ticket > Get ticket: Now you can get tickets for support channel
- Support channel - Ticket > Added new values for ticket context (
AGENT,CUSTOMER)
1.1.0
- Features / Enhancements
- Support channel - Ticket > Create ticket: Now you can create tickets for support channel
1.0.3
- Features / Enhancements
- Addressbook Contact External > Now you can create, read , update or delete a contact in external addressbook
- Phone channel - Call > Dial number: Now you can indicate the id of the contact on which the call made must lookup
1.0.2
- Features / Enhancements
- Power Dialer > Add list items (contacts): Now you can reset stats at the same time as inserting a contact in a list
- Power Dialer > Delete list items (contacts): Now you can delete one or more items from the contact list associated with a campaign that have yet to be called; also, you can reset stats at the same time as deleting a contact in a list
1.0.1
- Features / Enhancements
- Power Dialer > Add list items (contacts): Now you can specify contact information to create or update the contact in the address book
- Phone channel - Call: Added methods for call management (dial number, hangup call)
1.0.0
- First release
- Authentication, version and user session management
- Power Dialer campaign management for phone channel