ACD

The ACD API delivers information on existing agents, skill groups and ACD statistics.

/ACD/Agents GET

https://api.callone.de/v1000/json///ACD/Agents

You can use this resource to retrieve information on the agent (e.g. ID, status, name, etc.) and set a new status or phone numbers for the agent.
NameValueTypeRequ.ValuesDescription
filterString-destination
id
name
skill_group_id
status_id
Filters result by value.
sortString-destination
id
name
status_id
Sort result by value.
expandString-destinations
image
permissions
pi
profiles
profiles.announcement
profiles.image
sip_user
Additional informations by value.
{
  "version": {
    "used": "v1000",
    "expire": "none",
    "new_available": "v1000"
  },
  "response": {
    "count": 2,
    "data": [
      {
        "id": 12345,                                                /* Unique Agent ID */
        "name": "Jon Doe",                                          /* Name of Agent */
        "pin": "918273",                                            /* Password of Agent */
        "external_id": "0011223344",                                /* External CRM User ID, forwarded by CallConnect API */
        "status": {
          "id": 1,                                                  /* Current status ID of Agent */
          "name": "Verfügbar",                                      /* Current status name of Agent (german) */
          "message": "Ready to Rumble"                              /* User defined status message */
        },
        "supervisor": true,                                         /* Supervisor permission */
        "destination": "0001000001",                                /* Linked VOIP endpoint */
        "settings": {
          "inbound": {
            "na": 30                                                /* Postprocessing Time for Inbound Calls */
          },
          "outbound": {
            "na": 60                                                /* Postprocessing Time for Outbound Calls */
            "skill_group": 1234                                     /* Selected Outbound Skill Group ID */
          }
        },
        "description": null                                         /* Additional agent description */
      },
      {
        "id": 12346,                                                /* Unique Agent ID */
        "name": "Jane Doe",                                         /* Name of Agent */
        "pin": "827364",                                            /* Password of Agent */
        "external_id": "1122334455",                                /* External CRM User ID, forwarded by CallConnect API */
        "status": {
          "id": 6,                                                  /* Current status ID of Agent */
          "name": "Nicht Verfügbar",                                /* Current status name of Agent (german) */
          "message": null                                           /* User defined status message */
        },
        "supervisor": false,                                        /* Supervisor permission */
        "destination": "0001000002",                                /* Linked VOIP endpoint */
        "settings": {
          "inbound": {
            "na": 30                                                /* Postprocessing Time for Inbound Calls */
          },
          "outbound": {
            "na": 60                                                /* Postprocessing Time for Outbound Calls */
            "skill_group": null                                     /* Selected Outbound Skill Group ID */
          }
        },
        "description": null                                         /* Additional agent description */
      }
    ]
  }
}
curl -X GET "https://api.callone.de/v1000/json///ACD/Agents" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///ACD/Agents?'.http_build_query ($api_parameters, '', '&');

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///ACD/Agents'

response_json = requests.get (url, data=api_parameters)

/ACD/Agents POST

https://api.callone.de/v1000/json///ACD/Agents

Create new agents.
NameValueTypeRequ.ValuesDescription
nameStringYesSets agent display name.
pi_mailStringYesE-mail adress of agent.
supervisorString-false
true
Sets if agent is a supervisor or not.
outbound_provided_numberString-Set user defined number for outbound calls.
curl -X POST "https://api.callone.de/v1000/json///ACD/Agents" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///ACD/Agents';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt ($ch, CURLOPT_POSTFIELDS, json_encode ($api_parameters));
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///ACD/Agents'

response_json = requests.post (url, data=api_parameters)

/ACD/Agents/AID GET

https://api.callone.de/v1000/json///ACD/Agents/AID

Request informations about an agent.
NameValueTypeRequ.ValuesDescription
AIDURLYesUnique Agent ID.
expandString-destinations
image
permissions
pi
profiles
profiles.announcement
profiles.image
Additional informations by value.
curl -X GET "https://api.callone.de/v1000/json///ACD/Agents/AID" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///ACD/Agents/AID?'.http_build_query ($api_parameters, '', '&');

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///ACD/Agents/AID'

response_json = requests.get (url, data=api_parameters)

/ACD/Agents/AID PATCH

https://api.callone.de/v1000/json///ACD/Agents/AID

Set agent status to new status.
NameValueTypeRequ.ValuesDescription
AIDURLYesUnique Agent ID.
status_idNumber-New status ID.
curl -X PATCH "https://api.callone.de/v1000/json///ACD/Agents/AID" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///ACD/Agents/AID';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'PATCH');
curl_setopt ($ch, CURLOPT_POSTFIELDS, json_encode ($api_parameters));
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///ACD/Agents/AID'

response_json = requests.patch (url, data=api_parameters)

/ACD/Agents/AID DELETE

https://api.callone.de/v1000/json///ACD/Agents/AID

Delete an agent.
NameValueTypeRequ.ValuesDescription
AIDURLYesUnique Agent ID.
curl -X DELETE "https://api.callone.de/v1000/json///ACD/Agents/AID"
<?php
$url = 'https://api.callone.de/v1000/json///ACD/Agents/AID';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
curl_setopt ($ch, CURLOPT_POSTFIELDS, json_encode ($api_parameters));
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///ACD/Agents/AID'

response_json = requests.delete (url)

/ACD/Agents/AID/Destinations GET

https://api.callone.de/v1000/json///ACD/Agents/AID/Destinations

Get current destinations from an Agent.
NameValueTypeRequ.ValuesDescription
AIDURLYesUnique Agent ID.
curl -X GET "https://api.callone.de/v1000/json///ACD/Agents/AID/Destinations"
<?php
$url = 'https://api.callone.de/v1000/json///ACD/Agents/AID/Destinations';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///ACD/Agents/AID/Destinations'

response_json = requests.get (url)

/ACD/Agents/AID/Destinations POST

https://api.callone.de/v1000/json///ACD/Agents/AID/Destinations

Create a new destination for an Agent.
NameValueTypeRequ.ValuesDescription
AIDURLYesUnique Agent ID.
descriptionStringYesDestination Description
destinationNumberYesDestination Number
activeString-false
true
FIXME
hideString-false
true
FIXME
curl -X POST "https://api.callone.de/v1000/json///ACD/Agents/AID/Destinations" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///ACD/Agents/AID/Destinations';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt ($ch, CURLOPT_POSTFIELDS, json_encode ($api_parameters));
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///ACD/Agents/AID/Destinations'

response_json = requests.post (url, data=api_parameters)

/ACD/Agents/AID/Destinations/DID GET

https://api.callone.de/v1000/json///ACD/Agents/AID/Destinations/DID

FIXME
NameValueTypeRequ.ValuesDescription
AIDURLYesUnique Agent ID.
DIDURLYesUnique Destination ID.
curl -X GET "https://api.callone.de/v1000/json///ACD/Agents/AID/Destinations/DID"
<?php
$url = 'https://api.callone.de/v1000/json///ACD/Agents/AID/Destinations/DID';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///ACD/Agents/AID/Destinations/DID'

response_json = requests.get (url)

/ACD/Agents/AID/Destinations/DID PATCH

https://api.callone.de/v1000/json///ACD/Agents/AID/Destinations/DID

Update an existing destination.
NameValueTypeRequ.ValuesDescription
AIDURLYesUnique Agent ID.
DIDURLYesUnique Destination ID.
descriptionStringYesDestination Description
destinationNumberYesDestination Number
activeString-false
true
FIXME
hideString-false
true
FIXME
curl -X PATCH "https://api.callone.de/v1000/json///ACD/Agents/AID/Destinations/DID" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///ACD/Agents/AID/Destinations/DID';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'PATCH');
curl_setopt ($ch, CURLOPT_POSTFIELDS, json_encode ($api_parameters));
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///ACD/Agents/AID/Destinations/DID'

response_json = requests.patch (url, data=api_parameters)

/ACD/Agents/AID/Destinations/DID DELETE

https://api.callone.de/v1000/json///ACD/Agents/AID/Destinations/DID

Delete a destination.
NameValueTypeRequ.ValuesDescription
AIDURLYesUnique Agent ID.
DIDURLYesUnique Destination ID.
curl -X DELETE "https://api.callone.de/v1000/json///ACD/Agents/AID/Destinations/DID"
<?php
$url = 'https://api.callone.de/v1000/json///ACD/Agents/AID/Destinations/DID';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
curl_setopt ($ch, CURLOPT_POSTFIELDS, json_encode ($api_parameters));
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///ACD/Agents/AID/Destinations/DID'

response_json = requests.delete (url)

/ACD/Agents/AID/Destinations/COUNT GET

https://api.callone.de/v1000/json///ACD/Agents/AID/Destinations/COUNT

FIXME
NameValueTypeRequ.ValuesDescription
AIDURLYesUnique Agent ID.
curl -X GET "https://api.callone.de/v1000/json///ACD/Agents/AID/Destinations/COUNT"
<?php
$url = 'https://api.callone.de/v1000/json///ACD/Agents/AID/Destinations/COUNT';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///ACD/Agents/AID/Destinations/COUNT'

response_json = requests.get (url)

/ACD/Agents/AID/Permissions GET

https://api.callone.de/v1000/json///ACD/Agents/AID/Permissions

FIXME
NameValueTypeRequ.ValuesDescription
AIDURLYesUnique Agent ID.
curl -X GET "https://api.callone.de/v1000/json///ACD/Agents/AID/Permissions"
<?php
$url = 'https://api.callone.de/v1000/json///ACD/Agents/AID/Permissions';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///ACD/Agents/AID/Permissions'

response_json = requests.get (url)

/ACD/Agents/AID/Profiles GET

https://api.callone.de/v1000/json///ACD/Agents/AID/Profiles

FIXME
NameValueTypeRequ.ValuesDescription
AIDURLYesUnique Agent ID.
expandString-announcement
image
Additional informations by value.
curl -X GET "https://api.callone.de/v1000/json///ACD/Agents/AID/Profiles" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///ACD/Agents/AID/Profiles?'.http_build_query ($api_parameters, '', '&');

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///ACD/Agents/AID/Profiles'

response_json = requests.get (url, data=api_parameters)

/ACD/Agents/AID/Profiles POST

https://api.callone.de/v1000/json///ACD/Agents/AID/Profiles

FIXME
NameValueTypeRequ.ValuesDescription
AIDURLYesUnique Agent ID.
profilNumberYesFIXME
nicknameStringYesFIXME
directdialingStringYesFIXME
description_fullString-FIXME
description_shortString-FIXME
activeString-false
true
FIXME
curl -X POST "https://api.callone.de/v1000/json///ACD/Agents/AID/Profiles" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///ACD/Agents/AID/Profiles';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt ($ch, CURLOPT_POSTFIELDS, json_encode ($api_parameters));
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///ACD/Agents/AID/Profiles'

response_json = requests.post (url, data=api_parameters)

/ACD/Agents/AID/Profiles/PID GET

https://api.callone.de/v1000/json///ACD/Agents/AID/Profiles/PID

FIXME
NameValueTypeRequ.ValuesDescription
AIDURLYesUnique Agent ID.
PIDURLYesUnique Profile ID.
expandString-announcement
image
Additional informations by value.
curl -X GET "https://api.callone.de/v1000/json///ACD/Agents/AID/Profiles/PID" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///ACD/Agents/AID/Profiles/PID?'.http_build_query ($api_parameters, '', '&');

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///ACD/Agents/AID/Profiles/PID'

response_json = requests.get (url, data=api_parameters)

/ACD/Agents/AID/Profiles/COUNT GET

https://api.callone.de/v1000/json///ACD/Agents/AID/Profiles/COUNT

FIXME
NameValueTypeRequ.ValuesDescription
AIDURLYesUnique Agent ID.
curl -X GET "https://api.callone.de/v1000/json///ACD/Agents/AID/Profiles/COUNT"
<?php
$url = 'https://api.callone.de/v1000/json///ACD/Agents/AID/Profiles/COUNT';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///ACD/Agents/AID/Profiles/COUNT'

response_json = requests.get (url)

/ACD/Agents/AID/Status GET

https://api.callone.de/v1000/json///ACD/Agents/AID/Status

FIXME
NameValueTypeRequ.ValuesDescription
AIDURLYesUnique Agent ID.
start_dateDate-Date format needs to be YYYY-MM-DD.
end_dateDate-Date format needs to be YYYY-MM-DD.
{
  "version": {
    "used": "v1000",
    "expire": "none",
    "new_available": "v1000"
  },
  "response": {
    "count": 5,
    "data": [
      {
        "status": {
          "id": 6,                                                  /* Status ID */
          "name": "Nicht Verfügbar"                                 /* Status Name */
        },
        "duration": 53080,                                          /* Status duration in seconds */
        "changed": "2018-08-21 18:25:12",                           /* Status changed from previous value at this datetime */
        "changedby": "Agenten",                                     /* Status changed by Agent(manually), Phone or ACD */
        "created": "2018-08-22 09:09:52"                            /* Entry creation time (changed + duration = created) */
      },
      {
        "status": {
          "id": 1,
          "name": "Verfügbar"
        },
        "duration": 9806,
        "changed": "2018-08-22 09:09:52",
        "changedby": "Agenten",
        "created": "2018-08-22 11:53:18"
      },
      {
        "status": {
          "id": 10,
          "name": "Verbindungsaufbau"
        },
        "duration": 2,
        "changed": "2018-08-22 11:53:18",
        "changedby": "Telefon",
        "created": "2018-08-22 11:53:20"
      },
      {
        "status": {
          "id": 2,
          "name": "Im Gespräch"
        },
        "duration": 22,
        "changed": "2018-08-22 11:53:20",
        "changedby": "Telefon",
        "created": "2018-08-22 11:53:42"
      },
      {
        "status": {
          "id": 1,
          "name": "Verfügbar"
        },
        "duration": 1011,
        "changed": "2018-08-22 11:53:42",
        "changedby": "Telefon",
        "created": "2018-08-22 12:10:33"
      }
    ]
  }
}
curl -X GET "https://api.callone.de/v1000/json///ACD/Agents/AID/Status" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///ACD/Agents/AID/Status?'.http_build_query ($api_parameters, '', '&');

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///ACD/Agents/AID/Status'

response_json = requests.get (url, data=api_parameters)

/ACD/Agents/AID/Status/Times POST

https://api.callone.de/v1000/json///ACD/Agents/AID/Status/Times

FIXME
NameValueTypeRequ.ValuesDescription
AIDURLYesUnique Agent ID.
timeTimeYesTime format needs to be HH:MM:SS.
daysStringYesFIXME
status_idNumberYesFIXME
curl -X POST "https://api.callone.de/v1000/json///ACD/Agents/AID/Status/Times" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///ACD/Agents/AID/Status/Times';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt ($ch, CURLOPT_POSTFIELDS, json_encode ($api_parameters));
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///ACD/Agents/AID/Status/Times'

response_json = requests.post (url, data=api_parameters)

/ACD/Agents/AID/Status/Times/SID PATCH

https://api.callone.de/v1000/json///ACD/Agents/AID/Status/Times/SID

FIXME
NameValueTypeRequ.ValuesDescription
AIDURLYesUnique Agent ID.
SIDURLYesUnique Status ID.
timeTime-Time format needs to be HH:MM:SS.
daysString-FIXME
status_idNumber-FIXME
curl -X PATCH "https://api.callone.de/v1000/json///ACD/Agents/AID/Status/Times/SID" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///ACD/Agents/AID/Status/Times/SID';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'PATCH');
curl_setopt ($ch, CURLOPT_POSTFIELDS, json_encode ($api_parameters));
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///ACD/Agents/AID/Status/Times/SID'

response_json = requests.patch (url, data=api_parameters)

/ACD/Agents/AID/Status/Times/SID DELETE

https://api.callone.de/v1000/json///ACD/Agents/AID/Status/Times/SID

FIXME
NameValueTypeRequ.ValuesDescription
AIDURLYesUnique Agent ID.
SIDURLYesUnique Status ID.
curl -X DELETE "https://api.callone.de/v1000/json///ACD/Agents/AID/Status/Times/SID"
<?php
$url = 'https://api.callone.de/v1000/json///ACD/Agents/AID/Status/Times/SID';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
curl_setopt ($ch, CURLOPT_POSTFIELDS, json_encode ($api_parameters));
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///ACD/Agents/AID/Status/Times/SID'

response_json = requests.delete (url)

/ACD/Agents/COUNT GET

https://api.callone.de/v1000/json///ACD/Agents/COUNT

FIXME
NameValueTypeRequ.ValuesDescription
filterString-destination
id
name
skill_group_id
status_id
Filters result by value.
curl -X GET "https://api.callone.de/v1000/json///ACD/Agents/COUNT" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///ACD/Agents/COUNT?'.http_build_query ($api_parameters, '', '&');

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///ACD/Agents/COUNT'

response_json = requests.get (url, data=api_parameters)

/ACD/CDR GET

https://api.callone.de/v1000/json///ACD/CDR

FIXME
NameValueTypeRequ.ValuesDescription
start_dateDate-Date format needs to be YYYY-MM-DD.
end_dateDate-Date format needs to be YYYY-MM-DD.
start_timeTime-Time format needs to be HH:MM:SS.
end_timeTime-Time format needs to be HH:MM:SS.
filterString-agent_id
cdr_id
direction
id
skill_group_id
success
Filters result by value.
sortString-created
id
FIXME
limitNumber-Limits the maximum number of calls in the result.
offsetNumber-Query starts with the next data record (e.g. 101, if you enter 100).
curl -X GET "https://api.callone.de/v1000/json///ACD/CDR" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///ACD/CDR?'.http_build_query ($api_parameters, '', '&');

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///ACD/CDR'

response_json = requests.get (url, data=api_parameters)

/ACD/CDR/ACDCDRID GET

https://api.callone.de/v1000/json///ACD/CDR/ACDCDRID

FIXME
NameValueTypeRequ.ValuesDescription
ACDCDRIDURLYesUnique ACD Call Data Record ID.
curl -X GET "https://api.callone.de/v1000/json///ACD/CDR/ACDCDRID"
<?php
$url = 'https://api.callone.de/v1000/json///ACD/CDR/ACDCDRID';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///ACD/CDR/ACDCDRID'

response_json = requests.get (url)

/ACD/CDR/COUNT GET

https://api.callone.de/v1000/json///ACD/CDR/COUNT

FIXME
NameValueTypeRequ.ValuesDescription
start_dateDate-Date format needs to be YYYY-MM-DD.
end_dateDate-Date format needs to be YYYY-MM-DD.
start_timeTime-Time format needs to be HH:MM:SS.
end_timeTime-Time format needs to be HH:MM:SS.
filterString-agent_id
cdr_id
direction
id
skill_group_id
success
Filters result by value.
curl -X GET "https://api.callone.de/v1000/json///ACD/CDR/COUNT" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///ACD/CDR/COUNT?'.http_build_query ($api_parameters, '', '&');

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///ACD/CDR/COUNT'

response_json = requests.get (url, data=api_parameters)

/ACD/Settings GET

https://api.callone.de/v1000/json///ACD/Settings

This resource enables you to retrieve information on basic ACD settings such das ringing time, automatic logoff, etc.,
curl -X GET "https://api.callone.de/v1000/json///ACD/Settings"
<?php
$url = 'https://api.callone.de/v1000/json///ACD/Settings';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///ACD/Settings'

response_json = requests.get (url)

/ACD/Settings/Permissions GET

https://api.callone.de/v1000/json///ACD/Settings/Permissions

Receive information on the the permission settings of ACD agents. E.g. what they can see in the agent mask and if they are allowed to use the browser softphone. The API shows you the global settings.
curl -X GET "https://api.callone.de/v1000/json///ACD/Settings/Permissions"
<?php
$url = 'https://api.callone.de/v1000/json///ACD/Settings/Permissions';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///ACD/Settings/Permissions'

response_json = requests.get (url)

/ACD/Settings/Status GET

https://api.callone.de/v1000/json///ACD/Settings/Status

Receive information on ACD status settings. The API shows you each status that has been set up for the agents to use as well as the specific setting (active status, status can be interrupted by call, etc.) and the icon used for the status.
curl -X GET "https://api.callone.de/v1000/json///ACD/Settings/Status"
<?php
$url = 'https://api.callone.de/v1000/json///ACD/Settings/Status';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///ACD/Settings/Status'

response_json = requests.get (url)

/ACD/SkillGroups GET

https://api.callone.de/v1000/json///ACD/SkillGroups

This resource gives you information on skill groups, such as their ID and name.
curl -X GET "https://api.callone.de/v1000/json///ACD/SkillGroups"
<?php
$url = 'https://api.callone.de/v1000/json///ACD/SkillGroups';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///ACD/SkillGroups'

response_json = requests.get (url)

/ACD/SkillGroups/SGID GET

https://api.callone.de/v1000/json///ACD/SkillGroups/SGID

FIXME
NameValueTypeRequ.ValuesDescription
SGIDURLYesUnique Skill Group ID.
curl -X GET "https://api.callone.de/v1000/json///ACD/SkillGroups/SGID"
<?php
$url = 'https://api.callone.de/v1000/json///ACD/SkillGroups/SGID';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///ACD/SkillGroups/SGID'

response_json = requests.get (url)

/ACD/SkillGroups/SGID DELETE

https://api.callone.de/v1000/json///ACD/SkillGroups/SGID

Delete a Skill group.
NameValueTypeRequ.ValuesDescription
SGIDURLYesUnique Skill Group ID.
curl -X DELETE "https://api.callone.de/v1000/json///ACD/SkillGroups/SGID"
<?php
$url = 'https://api.callone.de/v1000/json///ACD/SkillGroups/SGID';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
curl_setopt ($ch, CURLOPT_POSTFIELDS, json_encode ($api_parameters));
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///ACD/SkillGroups/SGID'

response_json = requests.delete (url)

/ACD/SkillGroups/SGID/Members GET

https://api.callone.de/v1000/json///ACD/SkillGroups/SGID/Members

Request assigned agents from a skill group.
NameValueTypeRequ.ValuesDescription
SGIDURLYesUnique Skill Group ID.
curl -X GET "https://api.callone.de/v1000/json///ACD/SkillGroups/SGID/Members"
<?php
$url = 'https://api.callone.de/v1000/json///ACD/SkillGroups/SGID/Members';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///ACD/SkillGroups/SGID/Members'

response_json = requests.get (url)

/ACD/SkillGroups/SGID/Members POST

https://api.callone.de/v1000/json///ACD/SkillGroups/SGID/Members

Assign agent to skill group.
NameValueTypeRequ.ValuesDescription
SGIDURLYesUnique Skill Group ID.
agent_idNumberYesUnique Agent ID.
priorityNumber-Priority (0-9)
is_activeBoolean-false
true
Is agent assignment active?
is_lockedBoolean-false
true
Is agent allowed to remove himself from skill group?
curl -X POST "https://api.callone.de/v1000/json///ACD/SkillGroups/SGID/Members" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///ACD/SkillGroups/SGID/Members';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt ($ch, CURLOPT_POSTFIELDS, json_encode ($api_parameters));
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///ACD/SkillGroups/SGID/Members'

response_json = requests.post (url, data=api_parameters)

/ACD/SkillGroups/SGID/Members/AID DELETE

https://api.callone.de/v1000/json///ACD/SkillGroups/SGID/Members/AID

Remove assigned agent from a skill group.
NameValueTypeRequ.ValuesDescription
SGIDURLYesUnique Skill Group ID.
AIDURLYesUnique Agent ID.
curl -X DELETE "https://api.callone.de/v1000/json///ACD/SkillGroups/SGID/Members/AID"
<?php
$url = 'https://api.callone.de/v1000/json///ACD/SkillGroups/SGID/Members/AID';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
curl_setopt ($ch, CURLOPT_POSTFIELDS, json_encode ($api_parameters));
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///ACD/SkillGroups/SGID/Members/AID'

response_json = requests.delete (url)

/ACD/SkillGroups/COUNT GET

https://api.callone.de/v1000/json///ACD/SkillGroups/COUNT

FIXME
curl -X GET "https://api.callone.de/v1000/json///ACD/SkillGroups/COUNT"
<?php
$url = 'https://api.callone.de/v1000/json///ACD/SkillGroups/COUNT';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///ACD/SkillGroups/COUNT'

response_json = requests.get (url)

/ACD/SkillGroups/SGID/Items GET

https://api.callone.de/v1000/json///ACD/SkillGroups/SGID/Items

FIXME
NameValueTypeRequ.ValuesDescription
SGIDURLYesUnique Skill Group ID.
expandString-destinations
image
permissions
pi
profiles
profiles.announcement
profiles.image
Additional informations by value.
curl -X GET "https://api.callone.de/v1000/json///ACD/SkillGroups/SGID/Items" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///ACD/SkillGroups/SGID/Items?'.http_build_query ($api_parameters, '', '&');

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///ACD/SkillGroups/SGID/Items'

response_json = requests.get (url, data=api_parameters)

/ACD/Statistics

https://api.callone.de/v1000/json///ACD/Statistics

Retrieve information of the ACD agent statistics.

/ACD/Statistics/Agents/AID GET

https://api.callone.de/v1000/json///ACD/Statistics/Agents/AID

FIXME
NameValueTypeRequ.ValuesDescription
AIDURLYesUnique Agent ID.
start_dateDate-Date format needs to be YYYY-MM-DD.
end_dateDate-Date format needs to be YYYY-MM-DD.
start_timeTime-Time format needs to be HH:MM:SS.
end_timeTime-Time format needs to be HH:MM:SS.
daysString-FIXME
serviceString-FIXME
skill_groupNumber-FIXME
call_durationNumber-FIXME
call_duration_directionString-l
g
FIXME
curl -X GET "https://api.callone.de/v1000/json///ACD/Statistics/Agents/AID" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///ACD/Statistics/Agents/AID?'.http_build_query ($api_parameters, '', '&');

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///ACD/Statistics/Agents/AID'

response_json = requests.get (url, data=api_parameters)

/ACD/Statistics/Agents/AID/Days GET

https://api.callone.de/v1000/json///ACD/Statistics/Agents/AID/Days

FIXME
NameValueTypeRequ.ValuesDescription
AIDURLYesUnique Agent ID.
start_dateDate-Date format needs to be YYYY-MM-DD.
end_dateDate-Date format needs to be YYYY-MM-DD.
start_timeTime-Time format needs to be HH:MM:SS.
end_timeTime-Time format needs to be HH:MM:SS.
daysString-FIXME
serviceString-FIXME
skill_groupNumber-FIXME
call_durationNumber-FIXME
call_duration_directionString-l
g
FIXME
curl -X GET "https://api.callone.de/v1000/json///ACD/Statistics/Agents/AID/Days" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///ACD/Statistics/Agents/AID/Days?'.http_build_query ($api_parameters, '', '&');

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///ACD/Statistics/Agents/AID/Days'

response_json = requests.get (url, data=api_parameters)

/ACD/Statistics/Agents/AID/EVN GET

https://api.callone.de/v1000/json///ACD/Statistics/Agents/AID/EVN

FIXME
NameValueTypeRequ.ValuesDescription
AIDURLYesUnique Agent ID.
start_dateDate-Date format needs to be YYYY-MM-DD.
end_dateDate-Date format needs to be YYYY-MM-DD.
start_timeTime-Time format needs to be HH:MM:SS.
end_timeTime-Time format needs to be HH:MM:SS.
daysString-FIXME
serviceString-FIXME
skill_groupNumber-FIXME
call_durationNumber-FIXME
call_duration_directionString-l
g
FIXME
limitNumber-Limits the maximum number of calls in the result.
offsetNumber-Query starts with the next data record (e.g. 101, if you enter 100).
expandString-coding
Additional informations by value.
curl -X GET "https://api.callone.de/v1000/json///ACD/Statistics/Agents/AID/EVN" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///ACD/Statistics/Agents/AID/EVN?'.http_build_query ($api_parameters, '', '&');

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///ACD/Statistics/Agents/AID/EVN'

response_json = requests.get (url, data=api_parameters)

/ACD/Statistics/Agents/AID/EVN/COUNT GET

https://api.callone.de/v1000/json///ACD/Statistics/Agents/AID/EVN/COUNT

FIXME
NameValueTypeRequ.ValuesDescription
AIDURLYesUnique Agent ID.
start_dateDate-Date format needs to be YYYY-MM-DD.
end_dateDate-Date format needs to be YYYY-MM-DD.
start_timeTime-Time format needs to be HH:MM:SS.
end_timeTime-Time format needs to be HH:MM:SS.
daysString-FIXME
serviceString-FIXME
skill_groupNumber-FIXME
call_durationNumber-FIXME
call_duration_directionString-l
g
FIXME
limitNumber-Limits the maximum number of calls in the result.
offsetNumber-Query starts with the next data record (e.g. 101, if you enter 100).
curl -X GET "https://api.callone.de/v1000/json///ACD/Statistics/Agents/AID/EVN/COUNT" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///ACD/Statistics/Agents/AID/EVN/COUNT?'.http_build_query ($api_parameters, '', '&');

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///ACD/Statistics/Agents/AID/EVN/COUNT'

response_json = requests.get (url, data=api_parameters)

/ACD/Statistics/Agents/AID/Hours GET

https://api.callone.de/v1000/json///ACD/Statistics/Agents/AID/Hours

FIXME
NameValueTypeRequ.ValuesDescription
AIDURLYesUnique Agent ID.
start_dateDate-Date format needs to be YYYY-MM-DD.
end_dateDate-Date format needs to be YYYY-MM-DD.
start_timeTime-Time format needs to be HH:MM:SS.
end_timeTime-Time format needs to be HH:MM:SS.
daysString-FIXME
serviceString-FIXME
skill_groupNumber-FIXME
call_durationNumber-FIXME
call_duration_directionString-l
g
FIXME
curl -X GET "https://api.callone.de/v1000/json///ACD/Statistics/Agents/AID/Hours" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///ACD/Statistics/Agents/AID/Hours?'.http_build_query ($api_parameters, '', '&');

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///ACD/Statistics/Agents/AID/Hours'

response_json = requests.get (url, data=api_parameters)

/ACD/Statistics/Agents/AID/HalfHours GET

https://api.callone.de/v1000/json///ACD/Statistics/Agents/AID/HalfHours

FIXME
NameValueTypeRequ.ValuesDescription
AIDURLYesUnique Agent ID.
start_dateDate-Date format needs to be YYYY-MM-DD.
end_dateDate-Date format needs to be YYYY-MM-DD.
start_timeTime-Time format needs to be HH:MM:SS.
end_timeTime-Time format needs to be HH:MM:SS.
daysString-FIXME
serviceString-FIXME
skill_groupNumber-FIXME
call_durationNumber-FIXME
call_duration_directionString-l
g
FIXME
curl -X GET "https://api.callone.de/v1000/json///ACD/Statistics/Agents/AID/HalfHours" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///ACD/Statistics/Agents/AID/HalfHours?'.http_build_query ($api_parameters, '', '&');

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///ACD/Statistics/Agents/AID/HalfHours'

response_json = requests.get (url, data=api_parameters)

/ACD/Statistics/CallCoding GET

https://api.callone.de/v1000/json///ACD/Statistics/CallCoding

This gives you information on call coding statistics.
curl -X GET "https://api.callone.de/v1000/json///ACD/Statistics/CallCoding"
<?php
$url = 'https://api.callone.de/v1000/json///ACD/Statistics/CallCoding';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///ACD/Statistics/CallCoding'

response_json = requests.get (url)

/ACD/Statistics/CallCoding/Day GET

https://api.callone.de/v1000/json///ACD/Statistics/CallCoding/Day

FIXME
curl -X GET "https://api.callone.de/v1000/json///ACD/Statistics/CallCoding/Day"
<?php
$url = 'https://api.callone.de/v1000/json///ACD/Statistics/CallCoding/Day';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///ACD/Statistics/CallCoding/Day'

response_json = requests.get (url)

/ACD/Statistics/CallCoding/Hours GET

https://api.callone.de/v1000/json///ACD/Statistics/CallCoding/Hours

FIXME
curl -X GET "https://api.callone.de/v1000/json///ACD/Statistics/CallCoding/Hours"
<?php
$url = 'https://api.callone.de/v1000/json///ACD/Statistics/CallCoding/Hours';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///ACD/Statistics/CallCoding/Hours'

response_json = requests.get (url)

/ACD/Statistics/CallCoding/HalfHours GET

https://api.callone.de/v1000/json///ACD/Statistics/CallCoding/HalfHours

FIXME
curl -X GET "https://api.callone.de/v1000/json///ACD/Statistics/CallCoding/HalfHours"
<?php
$url = 'https://api.callone.de/v1000/json///ACD/Statistics/CallCoding/HalfHours';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///ACD/Statistics/CallCoding/HalfHours'

response_json = requests.get (url)

/ACD/Statistics/SkillGroups GET

https://api.callone.de/v1000/json///ACD/Statistics/SkillGroups

This resource delivers information from skill group inbound statistics.
curl -X GET "https://api.callone.de/v1000/json///ACD/Statistics/SkillGroups"
<?php
$url = 'https://api.callone.de/v1000/json///ACD/Statistics/SkillGroups';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///ACD/Statistics/SkillGroups'

response_json = requests.get (url)

/ACD/Statistics/SkillGroups/EVN GET

https://api.callone.de/v1000/json///ACD/Statistics/SkillGroups/EVN

FIXME
NameValueTypeRequ.ValuesDescription
start_dateDate-Date format needs to be YYYY-MM-DD.
end_dateDate-Date format needs to be YYYY-MM-DD.
start_timeTime-Time format needs to be HH:MM:SS.
end_timeTime-Time format needs to be HH:MM:SS.
serviceString-FIXME
call_statusString-overflow
successful
unsuccessful
FIXME
daysString-FIXME
filterString-cdr_id
duration
skill_group_id
wait_duration
Filters result by value.
limitNumber-Limits the maximum number of calls in the result.
offsetNumber-Query starts with the next data record (e.g. 101, if you enter 100).
expandString-coding
Additional informations by value.
curl -X GET "https://api.callone.de/v1000/json///ACD/Statistics/SkillGroups/EVN" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///ACD/Statistics/SkillGroups/EVN?'.http_build_query ($api_parameters, '', '&');

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///ACD/Statistics/SkillGroups/EVN'

response_json = requests.get (url, data=api_parameters)

/ACD/Statistics/SkillGroups/Outbound/EVN GET

https://api.callone.de/v1000/json///ACD/Statistics/SkillGroups/Outbound/EVN

FIXME
NameValueTypeRequ.ValuesDescription
start_dateDate-Date format needs to be YYYY-MM-DD.
end_dateDate-Date format needs to be YYYY-MM-DD.
start_timeTime-Time format needs to be HH:MM:SS.
end_timeTime-Time format needs to be HH:MM:SS.
serviceString-FIXME
call_statusString-successful
unsuccessful
FIXME
daysString-FIXME
filterString-cdr_id
duration
skill_group_id
wait_duration
Filters result by value.
limitNumber-Limits the maximum number of calls in the result.
offsetNumber-Query starts with the next data record (e.g. 101, if you enter 100).
expandString-coding
Additional informations by value.
curl -X GET "https://api.callone.de/v1000/json///ACD/Statistics/SkillGroups/Outbound/EVN" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///ACD/Statistics/SkillGroups/Outbound/EVN?'.http_build_query ($api_parameters, '', '&');

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///ACD/Statistics/SkillGroups/Outbound/EVN'

response_json = requests.get (url, data=api_parameters)
AgentBoard

Once a call is connected with an agent, these API modules allow to use the same function as in the agentboard.

/AgentBoard/AID/Conference GET

https://api.callone.de/v1000/json///AgentBoard/AID/Conference

Connect two calls from an agent together as a conference.
NameValueTypeRequ.ValuesDescription
AIDURLYesUnique Agent ID.
curl -X GET "https://api.callone.de/v1000/json///AgentBoard/AID/Conference"
<?php
$url = 'https://api.callone.de/v1000/json///AgentBoard/AID/Conference';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///AgentBoard/AID/Conference'

response_json = requests.get (url)

/AgentBoard/AID/DTMF GET

https://api.callone.de/v1000/json///AgentBoard/AID/DTMF

Send DTMF keys.
NameValueTypeRequ.ValuesDescription
AIDURLYesUnique Agent ID.
keysStringYesDTMF keys as 0-9*#.
curl -X GET "https://api.callone.de/v1000/json///AgentBoard/AID/DTMF" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///AgentBoard/AID/DTMF?'.http_build_query ($api_parameters, '', '&');

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///AgentBoard/AID/DTMF'

response_json = requests.get (url, data=api_parameters)

/AgentBoard/AID/Display GET

https://api.callone.de/v1000/json///AgentBoard/AID/Display

Additional agent information to be used in a separate agentboard.
NameValueTypeRequ.ValuesDescription
AIDURLYesUnique Agent ID.
curl -X GET "https://api.callone.de/v1000/json///AgentBoard/AID/Display"
<?php
$url = 'https://api.callone.de/v1000/json///AgentBoard/AID/Display';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///AgentBoard/AID/Display'

response_json = requests.get (url)

/AgentBoard/AID/Enquiry GET

https://api.callone.de/v1000/json///AgentBoard/AID/Enquiry

Put current call on hold while calling another destination.
NameValueTypeRequ.ValuesDescription
AIDURLYesUnique Agent ID.
destinationStringYesACD Agent Routing Name: AGENT:XXX
SKILL:XXX
SIP-Number / Phonenumber
curl -X GET "https://api.callone.de/v1000/json///AgentBoard/AID/Enquiry" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///AgentBoard/AID/Enquiry?'.http_build_query ($api_parameters, '', '&');

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///AgentBoard/AID/Enquiry'

response_json = requests.get (url, data=api_parameters)

/AgentBoard/AID/Hangup/CALL GET

https://api.callone.de/v1000/json///AgentBoard/AID/Hangup/CALL

Hangup a call of an agent.
NameValueTypeRequ.ValuesDescription
AIDURLYesUnique Agent ID.
CALLURLYes0
1
2
3
Call number from agent.
causeStringYesBUSY
NOANSWER
NORESPONSE
REJECTED
Hangup cause.
curl -X GET "https://api.callone.de/v1000/json///AgentBoard/AID/Hangup/CALL" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///AgentBoard/AID/Hangup/CALL?'.http_build_query ($api_parameters, '', '&');

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///AgentBoard/AID/Hangup/CALL'

response_json = requests.get (url, data=api_parameters)

/AgentBoard/AID/Hold/CALL GET

https://api.callone.de/v1000/json///AgentBoard/AID/Hold/CALL

Hold a call of an agent.
NameValueTypeRequ.ValuesDescription
AIDURLYesUnique Agent ID.
CALLURLYes0
1
2
3
Call number from agent.
curl -X GET "https://api.callone.de/v1000/json///AgentBoard/AID/Hold/CALL"
<?php
$url = 'https://api.callone.de/v1000/json///AgentBoard/AID/Hold/CALL';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///AgentBoard/AID/Hold/CALL'

response_json = requests.get (url)

/AgentBoard/AID/Record GET

https://api.callone.de/v1000/json///AgentBoard/AID/Record

Record current call of an agent.
NameValueTypeRequ.ValuesDescription
AIDURLYesUnique Agent ID.
curl -X GET "https://api.callone.de/v1000/json///AgentBoard/AID/Record"
<?php
$url = 'https://api.callone.de/v1000/json///AgentBoard/AID/Record';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///AgentBoard/AID/Record'

response_json = requests.get (url)

/AgentBoard/AID/RecordSettings GET

https://api.callone.de/v1000/json///AgentBoard/AID/RecordSettings

FIXME
NameValueTypeRequ.ValuesDescription
AIDURLYesUnique Agent ID.
labelStringYesFIXME: 3-64 chars
curl -X GET "https://api.callone.de/v1000/json///AgentBoard/AID/RecordSettings" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///AgentBoard/AID/RecordSettings?'.http_build_query ($api_parameters, '', '&');

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///AgentBoard/AID/RecordSettings'

response_json = requests.get (url, data=api_parameters)

/AgentBoard/AID/Transfer GET

https://api.callone.de/v1000/json///AgentBoard/AID/Transfer

Transfer current call to another destination.
NameValueTypeRequ.ValuesDescription
AIDURLYesUnique Agent ID.
destinationStringYesAGENT:XXX
SKILL:XXX
SIP-Number / Phonenumber
curl -X GET "https://api.callone.de/v1000/json///AgentBoard/AID/Transfer" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///AgentBoard/AID/Transfer?'.http_build_query ($api_parameters, '', '&');

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///AgentBoard/AID/Transfer'

response_json = requests.get (url, data=api_parameters)

/AgentBoard/AID/Vote GET

https://api.callone.de/v1000/json///AgentBoard/AID/Vote

Vote call quality.
NameValueTypeRequ.ValuesDescription
AIDURLYesUnique Agent ID.
votingNumberYes0
1
2
3
4
5
6
Vote is by german school grades.
curl -X GET "https://api.callone.de/v1000/json///AgentBoard/AID/Vote" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///AgentBoard/AID/Vote?'.http_build_query ($api_parameters, '', '&');

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///AgentBoard/AID/Vote'

response_json = requests.get (url, data=api_parameters)
Callback

The Callback API enables you to receive calls through a callback button on your website and equip this button with certain features such as option menus that can be routed individually via DDI, customized data fields and Text to Speech.

/Callback/ GET

https://api.callone.de/v1000/json///Callback/

With the GET resource, you can receive information on callbacks that were already triggered.
NameValueTypeRequ.ValuesDescription
idNumber-ID of the callback that has been initiated or is currently active.
req_tokenString-Token of callback that has been initiated or is currently active.
start_dateDate-Date format needs to be YYYY-MM-DD.
end_dateDate-Date format needs to be YYYY-MM-DD.
curl -X GET "https://api.callone.de/v1000/json///Callback/" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///Callback/?'.http_build_query ($api_parameters, '', '&');

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///Callback/'

response_json = requests.get (url, data=api_parameters)

/Callback/ POST

https://api.callone.de/v1000/json///Callback/

This resource enables you to create a callback button and set how many attempts are made to reach the customer, which language is used, etc.
NameValueTypeRequ.ValuesDescription
callerNumberYesPhone number of customer. Value will be checked for valid phone number format and blacklist.
idNumberYesCallback button ID. You can use either this or the button key to validate the callback button.
keyStringYesCallback button key. You can user either this or the button ID to validate the callback button.
nameString-Name of the customer to be called.
ip_addrString-IP address of the customer to be called.
data1String-Customizable data field for CallConnect API.
data2String-Customizable data field for CallConnect API.
data3String-Customizable data field for CallConnect API.
data10String-Customizable data field for CallConnect API.
emailString-E-mail address of the customer.
delayNumber-Defines the time until the first callback attempt is made in seconds.
ddiNumber-Defines to which DDI the call should be routed in the CallOne system.
countNumber-Defines how many attempts are made to call the customer.
break_secNumber-Defines the time until the next time number is called in seconds.
timeout_ringingNumber-Defines for how many seconds the number is called.
user_providedNumber-The number that is transmitted to the customer when callback is initiated. Please enter in 00XX format.
languageString-de
en
fr
pl
The value defines the language of the response.
blacklist_idNumber-ID of a blacklist to be checked for the number entered in "caller."
ttsArray-FIXME
curl -X POST "https://api.callone.de/v1000/json///Callback/" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///Callback/';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt ($ch, CURLOPT_POSTFIELDS, json_encode ($api_parameters));
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///Callback/'

response_json = requests.post (url, data=api_parameters)

/Callback/ DELETE

https://api.callone.de/v1000/json///Callback/

Use this resource to delete callbacks that have already been initiated.
NameValueTypeRequ.ValuesDescription
idNumberYesID of the callback to be deleted.
curl -X DELETE "https://api.callone.de/v1000/json///Callback/" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///Callback/';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
curl_setopt ($ch, CURLOPT_POSTFIELDS, json_encode ($api_parameters));
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///Callback/'

response_json = requests.delete (url, data=api_parameters)

/Callback/Buttons GET

https://api.callone.de/v1000/json///Callback/Buttons

FIXME
curl -X GET "https://api.callone.de/v1000/json///Callback/Buttons"
<?php
$url = 'https://api.callone.de/v1000/json///Callback/Buttons';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///Callback/Buttons'

response_json = requests.get (url)

/Callback/Buttons/COUNT GET

https://api.callone.de/v1000/json///Callback/Buttons/COUNT

FIXME
curl -X GET "https://api.callone.de/v1000/json///Callback/Buttons/COUNT"
<?php
$url = 'https://api.callone.de/v1000/json///Callback/Buttons/COUNT';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///Callback/Buttons/COUNT'

response_json = requests.get (url)

/Callback/Buttons/BID/Package GET

https://api.callone.de/v1000/json///Callback/Buttons/BID/Package

FIXME
NameValueTypeRequ.ValuesDescription
BIDURLYesUnique Button ID.
curl -X GET "https://api.callone.de/v1000/json///Callback/Buttons/BID/Package"
<?php
$url = 'https://api.callone.de/v1000/json///Callback/Buttons/BID/Package';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///Callback/Buttons/BID/Package'

response_json = requests.get (url)

/Callback/Check GET

https://api.callone.de/v1000/json///Callback/Check

This resource enables you to check callbacks that have already been initiated for certain parameters.
NameValueTypeRequ.ValuesDescription
idNumber-Callback button ID. You can use either this or the button key to validate the callback button.
keyString-Callback button key. You can user either this or the button ID to validate the callback button.
ddiNumber-Defines to which DDI the call was routed in the CallOne system.
delayNumber-Defines the time until the first callback attempt was made.
ip_addrString-IP address of the customer
callerNumberYesPhone number of the callback user.
blacklist_idNumber-ID of the blacklist used for this callback.
languageString-de
en
fr
pl
Language of the response text.
curl -X GET "https://api.callone.de/v1000/json///Callback/Check" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///Callback/Check?'.http_build_query ($api_parameters, '', '&');

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///Callback/Check'

response_json = requests.get (url, data=api_parameters)

/Callback/Codes GET

https://api.callone.de/v1000/json///Callback/Codes

FIXME
curl -X GET "https://api.callone.de/v1000/json///Callback/Codes"
<?php
$url = 'https://api.callone.de/v1000/json///Callback/Codes';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///Callback/Codes'

response_json = requests.get (url)
CDR

The CDR API provides an extensive documentation of calls in the form of so-called Call Detail Records (CDR). These records include the time, duration, status, phone numbers and many other essential values of the call. CDR information can be used in Business Intelligence to evaluate the call volume, SLAs, performance and other key business measures. The records can be filtered by time & date, sucessfull or unsuccessful calls, id, caller, etc.

/CDR/ GET

https://api.callone.de/v1000/json///CDR/

List all call detail records based on the available parameters such as time and date, id, in- or outbound, sucessful or unsuccessful call. You can also limit the CDR results by setting an offset, a limit of result entries or start the CDR entries with a certain ID.
NameValueTypeRequ.ValuesDescription
idNumber-Query starts with the next data record that has a higher ID.
directionString-IN
OUT
Filters between inbound and outbound calls.
start_dateDate-Date format needs to be YYYY-MM-DD.
end_dateDate-Date format needs to be YYYY-MM-DD.
start_timeTime-Time format needs to be HH:MM:SS.
end_timeTime-Time format needs to be HH:MM:SS.
successfullyBoolean-false
true
Filters result between successful and unsuccessful calls.
filterString-uuid
Filters result by value.
sortString-caller
date_time
ddi
id
service
Sorts result by value.
expandString-acd.agents
acd.skillgroups.inbound
acd.skillgroups.outbound
callback
click2call
coding
references
routingpoints
Additional informations by value.
limitNumber-Limits the maximum number of calls in the result.
offsetNumber-Query starts with the next data record (e.g. 101, if you enter 100).
Inbound call from external number. First skill group agent didn't pick up the call, so after a ringing timeout the next agent was triggered.
{
  "version": {
    "used": "v1000",
    "expire": "none",
    "new_available": "v1000"
  },
  "response": {
    "count": 1,
    "data": [
      {
        "id": 123456789,                                            /* Main unique CDR ID (human friendly) */
        "uuid": "aaaaaaaa-1234-bbbb-5678-cccccccccccc",             /* Main unique CDR ID */
        "direction": "inbound",                                     /* Call direction */
        "caller": "004915112345XXX",                                /* Phone number transmitted by call-initiating party or VoIP endpoint number */
        "service": "06131-9504960",                                 /* Phone number dialed by call-initiating party, VoIP endpoint or agent ID  */
        "ddi": "007",                                               /* Direct dial in (DDI) of a destination number or "INT" for internal calls */
        "profil": "DE_VoIP",                                        /* Billing profile used for this service */
        "modul": {
          "id": 332
        },
        "duration_in": 60,                                          /* Call duration including waiting queue time */
        "duration_out": 8,                                          /* In-call time: Agent and destination were connected and talked */
        "wait_duration": 4,                                         /* Waiting queue time in last skill group, ringing time excluded */
        "successfully": true,                                       /* True, if call was successful; false, if call was not sucessful */
        "date_time": "22.05.2018 15:43:00",                         /* Call start date and time */
        "out": [                                                    /* The out part contains all called parties */ 
          {
            "id": 123456791,                                        /* Unique call part ID (human friendly) */
            "uuid": "cccccccc-1234-dddd-5678-eeeeeeeeeeee",         /* Unique call part ID */
            "destination": "0001000002",                            /* VoIP endpoint or phone number */
            "description": "Jane Doe[23456]",                       /* Description entered for agent or VoIP endpoint */
            "duration_ringing": 3,                                  /* Ringing duration */
            "duration": 8,                                          /* Talk time */
            "success": 1,                                           /* 1, if party picked up; 0, if party did not pick up */
            "hangup_cause": "normal_clearing",                      /* VoIP or PSTN release cause */
            "date_time": "22.05.2018 15:43:49"                      /* Start date and time for this section of the call */
          },
          {
            "id": 1234567890,                                       /* Unique call part ID (human friendly) */
            "uuid": "bbbbbbbb-1234-cccc-5678-dddddddddddd",         /* Unique call part ID */
            "destination": "0001000001",                            /* VoIP endpoint or phone number */
            "description": "John Doe[12345]",                       /* Description entered for agent or VoIP endpoint */
            "duration_ringing": 20,                                 /* Ringing duration */
            "duration": 0,                                          /* Talk time */
            "success": 0,                                           /* If party picked up value is 1, if did't pick up value is 0 */
            "hangup_cause": "no_answer",                            /* VoIP or PSTN release cause */
            "date_time": "22.05.2018 15:43:13"                      /* Start date and time for this section of the call */
          }
        ],
        "history": {
          "href": "/CDR/123456789/History"
        },
        "coding": {
          "count": 1,
          "data": [
            {
              "id": 123,
              "own_id": 567,
              "description": "Order"                                /* Selected Call Coding */
            }
          ]
        }
      }
    ]
  }
}
Outbound call to external number, initiated by Click to Call.
{
  "version": {
    "used": "v1000",
    "expire": "none",
    "new_available": "v1000"
  },
  "response": {
    "count": 1,
    "data": [
      {
        "id": 123456789,                                            /* Main unique CDR ID (human friendly) */
        "uuid": "aaaaaaaa-1234-bbbb-5678-cccccccccccc",             /* Main unique CDR ID */
        "direction": "outbound",                                    /* Call direction */
        "caller": "0001000001",                                     /* Phone number transmitted by call-initiating party or VoIP endpoint number */
        "service": "VoIP-0001000001",                               /* Phone number dialed by call-initiating party, VoIP endpoint or agent ID  */
        "ddi": null,                                                /* Direct dial in (DDI) of a destination number or "INT" for internal calls */
        "profil": "DE_VoIP",                                        /* Billing profile used for this service */
        "modul": {
          "id": 600
        },
        "duration_in": 22,                                          /* Duration from Agent picking up the call till hangup */
        "duration_out": 32,                                         /* Summarised Agent and destination duration */
        "wait_duration": 0,                                         /* Waiting queue time, ringing time excluded */
        "successfully": true,                                       /* True, if call was successful; false, if call was not sucessful */
        "date_time": "22.05.2018 16:22:18",                         /* Call start date and time */
        "out": [                                                    /* The out part contains all called parties */ 
          {
            "id": 123456791,                                        /* Unique call part ID (human friendly) */
            "uuid": "cccccccc-1234-dddd-5678-eeeeeeeeeeee",         /* Unique call part ID */
            "destination": "004915112345678",                       /* VoIP endpoint or phone number */
            "description": "",                                      /* Description entered for agent or VoIP endpoint */
            "duration_ringing": 4,                                  /* Ringing duration */
            "duration": 10,                                         /* Talk time */
            "success": true,                                        /* true, if party picked up; false, if party did not pick up */
            "hangup_cause": "normal_clearing",                      /* VoIP or PSTN release cause */
            "date_time": "22.05.2018 16:22:21"                      /* Start date and time for this section of the call */
          },
          {
            "id": 1234567890,                                       /* Unique call part ID (human friendly) */
            "uuid": "bbbbbbbb-1234-cccc-5678-dddddddddddd",         /* Unique call part ID */
            "destination": "0001000001",                            /* VoIP endpoint or phone number */
            "description": "Snom 370 of John Doe",                  /* Description entered for agent or VoIP endpoint */
            "duration_ringing": 2,                                  /* Ringing duration */
            "duration": 22,                                         /* Duration from Agent picking up the call till hangup */
            "success": true,                                        /* If party picked up value is true, if did't pick up value is false */
            "hangup_cause": "normal_clearing",                      /* VoIP or PSTN release cause */
            "date_time": "22.05.2018 16:22:19"                      /* Start date and time for this section of the call */
          }
        ],
        "history": {
          "href": "/CDR/123456789/History"
        },
        "coding": {
          "count": 0,
          "data": []
        }
      }
    ]
  }
}
curl -X GET "https://api.callone.de/v1000/json///CDR/" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///CDR/?'.http_build_query ($api_parameters, '', '&');

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///CDR/'

response_json = requests.get (url, data=api_parameters)

/CDR/CID/History GET

https://api.callone.de/v1000/json///CDR/CID/History

FIXME
NameValueTypeRequ.ValuesDescription
CIDURLYesUnique CDR ID.
curl -X GET "https://api.callone.de/v1000/json///CDR/CID/History"
<?php
$url = 'https://api.callone.de/v1000/json///CDR/CID/History';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///CDR/CID/History'

response_json = requests.get (url)

/CDR/COUNT GET

https://api.callone.de/v1000/json///CDR/COUNT

CDR count provides you with the number of call detail records for the time span entered.
NameValueTypeRequ.ValuesDescription
idNumber-Query starts with the next data record that has a higher ID.
directionString-IN
OUT
Filters between inbound and outbound calls.
start_dateDate-Date format needs to be YYYY-MM-DD.
end_dateDate-Date format needs to be YYYY-MM-DD.
start_timeTime-Time format needs to be HH:MM:SS.
end_timeTime-Time format needs to be HH:MM:SS.
successfullyBoolean-false
true
Filters result between successful and unsuccessful calls.
curl -X GET "https://api.callone.de/v1000/json///CDR/COUNT" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///CDR/COUNT?'.http_build_query ($api_parameters, '', '&');

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///CDR/COUNT'

response_json = requests.get (url, data=api_parameters)
Click2Call

With the Click to Call API you can initiate a call automatically. The call can be triggered to an endpoint, an ACD agent or a phone number. The Click to Call function can be used to integrate telephony with a CRM system.

/Click2Call/ACD GET

https://api.callone.de/v1000/json///Click2Call/ACD

Connect an ACD agent with a phone number. The agent first receives a call. If this call is answered, the phone number will be called. The number to be transmitted to the called party can be chosen freely.
NameValueTypeRequ.ValuesDescription
agentNumberYesAgent ID. Value will be checked for valid ACD Agent ID.
destinationNumberYesPhone number. Value will be checked for valid phone number format and blacklist.
skill_groupNumber-ID of skill group from which the defined number is transmitted to the b_destination.
auto_answerBoolean-false
true
Defines if the call should be connected with the agent straight away or if the agent has to manually accept the call.
data1String-Customizable data field for CallConnect API.
data2String-Customizable data field for CallConnect API.
data3String-Customizable data field for CallConnect API.
data10String-Customizable data field for CallConnect API.
curl -X GET "https://api.callone.de/v1000/json///Click2Call/ACD" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///Click2Call/ACD?'.http_build_query ($api_parameters, '', '&');

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///Click2Call/ACD'

response_json = requests.get (url, data=api_parameters)

/Click2Call/Direct GET

https://api.callone.de/v1000/json///Click2Call/Direct

Connect two phone numbers. The first phone number first receives a call. If this call is answered, the second phone number will be called. The number to be transmitted to the called party can be chosen freely.
NameValueTypeRequ.ValuesDescription
a_destinationNumberYesFirst phone number. Value will be checked for valid phone number format and blacklist.
b_destinationNumberYesSecond phone number. Value will be checked for valid phone number format and blacklist.
user_providedNumber-Number to be transmitted to the b_destination.
statistik_nameString-Name of Click to Call Direct call in the statistics.
data1String-Customizable data field for CallConnect API.
data2String-Customizable data field for CallConnect API.
data3String-Customizable data field for CallConnect API.
data10String-Customizable data field for CallConnect API.
curl -X GET "https://api.callone.de/v1000/json///Click2Call/Direct" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///Click2Call/Direct?'.http_build_query ($api_parameters, '', '&');

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///Click2Call/Direct'

response_json = requests.get (url, data=api_parameters)

/Click2Call/SIP GET

https://api.callone.de/v1000/json///Click2Call/SIP

Connect a SIP user with a phone number. The SIP user first receives a call. If this call is answered, the phone number will be called. The number to be transmitted to the called party can be chosen freely.
NameValueTypeRequ.ValuesDescription
sipuserNumberYesSip User ID. Value will be checked for valid SIP User ID.
destinationNumberYesPhone number. Value will be checked for valid phone number format and blacklist.
auto_answerBoolean-false
true
Defines if the call should be connected with the SIP user straight away or if the SIP user has to manually accept the call.
data1String-Customizable data field for CallConnect API.
data2String-Customizable data field for CallConnect API.
data3String-Customizable data field for CallConnect API.
data10String-Customizable data field for CallConnect API.
curl -X GET "https://api.callone.de/v1000/json///Click2Call/SIP" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///Click2Call/SIP?'.http_build_query ($api_parameters, '', '&');

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///Click2Call/SIP'

response_json = requests.get (url, data=api_parameters)
Customers

List customer informations.

/Customers/ GET

https://api.callone.de/v1000/json///Customers/

Request customer account information.
NameValueTypeRequ.ValuesDescription
extensionString-reseller
To be used by resellers only.
curl -X GET "https://api.callone.de/v1000/json///Customers/" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///Customers/?'.http_build_query ($api_parameters, '', '&');

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///Customers/'

response_json = requests.get (url, data=api_parameters)

/Customers/Billings GET

https://api.callone.de/v1000/json///Customers/Billings

Get billing information.
curl -X GET "https://api.callone.de/v1000/json///Customers/Billings"
<?php
$url = 'https://api.callone.de/v1000/json///Customers/Billings';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///Customers/Billings'

response_json = requests.get (url)

/Customers/DSGVO GET

https://api.callone.de/v1000/json///Customers/DSGVO

FIXME
curl -X GET "https://api.callone.de/v1000/json///Customers/DSGVO"
<?php
$url = 'https://api.callone.de/v1000/json///Customers/DSGVO';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///Customers/DSGVO'

response_json = requests.get (url)
Fax

The FAX API enables you to send and receive faxes via an API, e.g. directly from your CRM.

/Fax/ POST

https://api.callone.de/v1000/json///Fax/

Use this to upload a file to send via fax.
NameValueTypeRequ.ValuesDescription
destinationStringYesPhone numbers, separated by semicolon (;). Values will be checked for valid phone number format and blacklist.
headerStringYesHeadline, length needs to be 3-64 chars.
sendernumberNumberYesPhone number. Value will be checked for valid phone number format and blacklist.
fileFileYesPDF file content to be send.
email_toString-Email addresses which receive a delivery report, separated by semicolon (;).
email_bccString-Email addresses which receive a delivery report, separated by semicolon (;).
countNumber-Number of tries after connection error, needs to be 1-3.
break_secNumber-Delay between tries, needs to be 60-300.
languageString-de
en
Language of delivery report.
costidNumber-Defines the cost center of the fax for your account billing.
notify_urlString-URL which receive a delivery report by GET parameters: UID, destination, status, pages and duration. URL needs to be HTTPS.
statistik_nameString-Name to be used for adding the fax to the statistics in our service portal.
curl -X POST "https://api.callone.de/v1000/json///Fax/" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///Fax/';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt ($ch, CURLOPT_POSTFIELDS, json_encode ($api_parameters));
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///Fax/'

response_json = requests.post (url, data=api_parameters)
Files

The API provides you with files from the administration section of the CallOne plattform, for example mailbox messages, faxes, call recordings and audio messages.

/Files/Audio GET

https://api.callone.de/v1000/json///Files/Audio

Gives you information on audio files uploaded on the CallOne plattform.
NameValueTypeRequ.ValuesDescription
sortString-created
id
Sort result by value.
limitNumber-Limits the maximum number of calls in the result.
offsetNumber-Query starts with the next data record (e.g. 101, if you enter 100).
curl -X GET "https://api.callone.de/v1000/json///Files/Audio" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///Files/Audio?'.http_build_query ($api_parameters, '', '&');

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///Files/Audio'

response_json = requests.get (url, data=api_parameters)

/Files/Audio/AID GET

https://api.callone.de/v1000/json///Files/Audio/AID

Retreive an audio file.
NameValueTypeRequ.ValuesDescription
AIDURLYesUnique audio ID.
curl -X GET "https://api.callone.de/v1000/json///Files/Audio/AID"
<?php
$url = 'https://api.callone.de/v1000/json///Files/Audio/AID';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///Files/Audio/AID'

response_json = requests.get (url)

/Files/Audio/COUNT GET

https://api.callone.de/v1000/json///Files/Audio/COUNT

This resource provides you with the number of audio files.
curl -X GET "https://api.callone.de/v1000/json///Files/Audio/COUNT"
<?php
$url = 'https://api.callone.de/v1000/json///Files/Audio/COUNT';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///Files/Audio/COUNT'

response_json = requests.get (url)

/Files/Fax GET

https://api.callone.de/v1000/json///Files/Fax

Gives you information on fax messages you sent and received.
curl -X GET "https://api.callone.de/v1000/json///Files/Fax"
<?php
$url = 'https://api.callone.de/v1000/json///Files/Fax';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///Files/Fax'

response_json = requests.get (url)

/Files/Mailbox GET

https://api.callone.de/v1000/json///Files/Mailbox

Give you information on mailbox messages you received.
curl -X GET "https://api.callone.de/v1000/json///Files/Mailbox"
<?php
$url = 'https://api.callone.de/v1000/json///Files/Mailbox';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///Files/Mailbox'

response_json = requests.get (url)

/Files/Mailbox/MID GET

https://api.callone.de/v1000/json///Files/Mailbox/MID

Retreive a mailbox file.
NameValueTypeRequ.ValuesDescription
MIDURLYesUnique mailbox ID.
curl -X GET "https://api.callone.de/v1000/json///Files/Mailbox/MID"
<?php
$url = 'https://api.callone.de/v1000/json///Files/Mailbox/MID';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///Files/Mailbox/MID'

response_json = requests.get (url)

/Files/Record GET

https://api.callone.de/v1000/json///Files/Record

Gives you information on voice recordings of phone calls.
NameValueTypeRequ.ValuesDescription
start_dateDate-Date format needs to be YYYY-MM-DD.
end_dateDate-Date format needs to be YYYY-MM-DD.
filterString-cdr_id
uuid
Filters result by value.
sortString-caller
created
ddi
id
service
Sort result by value.
limitNumber-Limits the maximum number of calls in the result.
offsetNumber-Query starts with the next data record (e.g. 101, if you enter 100).
curl -X GET "https://api.callone.de/v1000/json///Files/Record" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///Files/Record?'.http_build_query ($api_parameters, '', '&');

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///Files/Record'

response_json = requests.get (url, data=api_parameters)

/Files/Record/RID GET

https://api.callone.de/v1000/json///Files/Record/RID

Retreive a record file.
NameValueTypeRequ.ValuesDescription
RIDURLYesUnique record ID.
curl -X GET "https://api.callone.de/v1000/json///Files/Record/RID"
<?php
$url = 'https://api.callone.de/v1000/json///Files/Record/RID';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///Files/Record/RID'

response_json = requests.get (url)

/Files/Record/COUNT GET

https://api.callone.de/v1000/json///Files/Record/COUNT

This resource provides you with the number of record files.
NameValueTypeRequ.ValuesDescription
start_dateDate-Date format needs to be YYYY-MM-DD.
end_dateDate-Date format needs to be YYYY-MM-DD.
curl -X GET "https://api.callone.de/v1000/json///Files/Record/COUNT" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///Files/Record/COUNT?'.http_build_query ($api_parameters, '', '&');

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///Files/Record/COUNT'

response_json = requests.get (url, data=api_parameters)
Global

This rescource gives you information on countries available in customer data and an overview of all available routing modules.

/Global/Check/Address GET

https://api.callone.de/v1000/json///Global/Check/Address

FIXME
NameValueTypeRequ.ValuesDescription
streetStringYesFIXME
zipcodeNumberYesFIXME
cityStringYesFIXME
countryString-FIXME
curl -X GET "https://api.callone.de/v1000/json///Global/Check/Address" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///Global/Check/Address?'.http_build_query ($api_parameters, '', '&');

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///Global/Check/Address'

response_json = requests.get (url, data=api_parameters)

/Global/Check/AreaCode GET

https://api.callone.de/v1000/json///Global/Check/AreaCode

FIXME
NameValueTypeRequ.ValuesDescription
latitudeFloatYesFIXME
longitudeFloatYesFIXME
curl -X GET "https://api.callone.de/v1000/json///Global/Check/AreaCode" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///Global/Check/AreaCode?'.http_build_query ($api_parameters, '', '&');

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///Global/Check/AreaCode'

response_json = requests.get (url, data=api_parameters)

/Global/Countrys GET

https://api.callone.de/v1000/json///Global/Countrys

Gives you all available countries to select in customer data.
curl -X GET "https://api.callone.de/v1000/json///Global/Countrys"
<?php
$url = 'https://api.callone.de/v1000/json///Global/Countrys';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///Global/Countrys'

response_json = requests.get (url)

/Global/Modules GET

https://api.callone.de/v1000/json///Global/Modules

Gives you all types of routing points available.
curl -X GET "https://api.callone.de/v1000/json///Global/Modules"
<?php
$url = 'https://api.callone.de/v1000/json///Global/Modules';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///Global/Modules'

response_json = requests.get (url)

/Global/Services GET

https://api.callone.de/v1000/json///Global/Services

FIXME
curl -X GET "https://api.callone.de/v1000/json///Global/Services"
<?php
$url = 'https://api.callone.de/v1000/json///Global/Services';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///Global/Services'

response_json = requests.get (url)
Lists

The Lists API enables you to view and manage any lists available in CallOne. For example, you could add or remove entries from the blacklist.

/Lists/Blacklists GET

https://api.callone.de/v1000/json///Lists/Blacklists

Receive information on your blacklist.
curl -X GET "https://api.callone.de/v1000/json///Lists/Blacklists"
<?php
$url = 'https://api.callone.de/v1000/json///Lists/Blacklists';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///Lists/Blacklists'

response_json = requests.get (url)

/Lists/Blacklists POST

https://api.callone.de/v1000/json///Lists/Blacklists

Create a new blacklist entry.
NameValueTypeRequ.ValuesDescription
callerNumberYesPhone number of customer. Value will be checked for valid phone number format.
descriptionStringYesInformational description text, length needs to be 3 till 64 charachters.
blockBoolean-false
true
All possible extension numbers (DDI) for a phone number block.
locked_upDate-Timestamp until the entry is blocked, format needs to be YYYY-MM-DD HH:MM:SS.
curl -X POST "https://api.callone.de/v1000/json///Lists/Blacklists" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///Lists/Blacklists';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt ($ch, CURLOPT_POSTFIELDS, json_encode ($api_parameters));
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///Lists/Blacklists'

response_json = requests.post (url, data=api_parameters)

/Lists/Blacklists/BLID DELETE

https://api.callone.de/v1000/json///Lists/Blacklists/BLID

FIXME
NameValueTypeRequ.ValuesDescription
BLIDURLYesUnique blacklist entry ID.
curl -X DELETE "https://api.callone.de/v1000/json///Lists/Blacklists/BLID"
<?php
$url = 'https://api.callone.de/v1000/json///Lists/Blacklists/BLID';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
curl_setopt ($ch, CURLOPT_POSTFIELDS, json_encode ($api_parameters));
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///Lists/Blacklists/BLID'

response_json = requests.delete (url)

/Lists/CallCodings GET

https://api.callone.de/v1000/json///Lists/CallCodings

Receive information on all call codes you have set up in your account (name, ID, date of creation).
curl -X GET "https://api.callone.de/v1000/json///Lists/CallCodings"
<?php
$url = 'https://api.callone.de/v1000/json///Lists/CallCodings';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///Lists/CallCodings'

response_json = requests.get (url)

/Lists/CallCodings POST

https://api.callone.de/v1000/json///Lists/CallCodings

FIXME
NameValueTypeRequ.ValuesDescription
own_idNumberYesFIXME
descriptionStringYesFIXME
curl -X POST "https://api.callone.de/v1000/json///Lists/CallCodings" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///Lists/CallCodings';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt ($ch, CURLOPT_POSTFIELDS, json_encode ($api_parameters));
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///Lists/CallCodings'

response_json = requests.post (url, data=api_parameters)

/Lists/Callerlists GET

https://api.callone.de/v1000/json///Lists/Callerlists

List available callerlists.
curl -X GET "https://api.callone.de/v1000/json///Lists/Callerlists"
<?php
$url = 'https://api.callone.de/v1000/json///Lists/Callerlists';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///Lists/Callerlists'

response_json = requests.get (url)

/Lists/Callerlists/CLID/Items GET

https://api.callone.de/v1000/json///Lists/Callerlists/CLID/Items

FIXME
NameValueTypeRequ.ValuesDescription
CLIDURLYesUnique callerlist ID.
curl -X GET "https://api.callone.de/v1000/json///Lists/Callerlists/CLID/Items"
<?php
$url = 'https://api.callone.de/v1000/json///Lists/Callerlists/CLID/Items';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///Lists/Callerlists/CLID/Items'

response_json = requests.get (url)

/Lists/Callerlists POST

https://api.callone.de/v1000/json///Lists/Callerlists

Create a new callerlist.
NameValueTypeRequ.ValuesDescription
nameStringYesCallerlist name, length needs to be 3 till 64 charachters.
descriptionStringYesInformational description text, length needs to be 3 till 64 charachters.
curl -X POST "https://api.callone.de/v1000/json///Lists/Callerlists" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///Lists/Callerlists';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt ($ch, CURLOPT_POSTFIELDS, json_encode ($api_parameters));
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///Lists/Callerlists'

response_json = requests.post (url, data=api_parameters)

/Lists/Callerlists/CLID/Items POST

https://api.callone.de/v1000/json///Lists/Callerlists/CLID/Items

Create a new callerlist entry.
NameValueTypeRequ.ValuesDescription
CLIDURLYesUnique callerlist ID.
callerNumberYesPhone number of customer. Value will be checked for valid phone number format.
descriptionStringYesInformational description text, length needs to be 3 till 64 charachters.
blockBoolean-false
true
All possible extension numbers (DDI) for a phone number block.
own_idString-Own entry id, for example from a crm, length needs to be 3 till 64 charachters.
locked_upDateTime-Timestamp until the entry is valid, format needs to be YYYY-MM-DD HH:MM:SS.
curl -X POST "https://api.callone.de/v1000/json///Lists/Callerlists/CLID/Items" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///Lists/Callerlists/CLID/Items';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt ($ch, CURLOPT_POSTFIELDS, json_encode ($api_parameters));
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///Lists/Callerlists/CLID/Items'

response_json = requests.post (url, data=api_parameters)

/Lists/Callerlists/CLID/Items/EID PATCH

https://api.callone.de/v1000/json///Lists/Callerlists/CLID/Items/EID

Patch a callerlist entry.
NameValueTypeRequ.ValuesDescription
CLIDURLYesUnique callerlist ID.
EIDURLYesUnique callerlist entry ID.
callerNumberYesPhone number of customer. Value will be checked for valid phone number format.
descriptionStringYesInformational description text, length needs to be 3 till 64 charachters.
blockBoolean-false
true
All possible extension numbers (DDI) for a phone number block.
own_idString-Own entry id, for example from a crm, length needs to be 3 till 64 charachters.
locked_upDateTime-Timestamp until the entry is valid, format needs to be YYYY-MM-DD HH:MM:SS.
curl -X PATCH "https://api.callone.de/v1000/json///Lists/Callerlists/CLID/Items/EID" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///Lists/Callerlists/CLID/Items/EID';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'PATCH');
curl_setopt ($ch, CURLOPT_POSTFIELDS, json_encode ($api_parameters));
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///Lists/Callerlists/CLID/Items/EID'

response_json = requests.patch (url, data=api_parameters)

/Lists/Callerlists/CLID DELETE

https://api.callone.de/v1000/json///Lists/Callerlists/CLID

Delete a callerlist.
NameValueTypeRequ.ValuesDescription
CLIDURLYesUnique callerlist ID.
curl -X DELETE "https://api.callone.de/v1000/json///Lists/Callerlists/CLID"
<?php
$url = 'https://api.callone.de/v1000/json///Lists/Callerlists/CLID';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
curl_setopt ($ch, CURLOPT_POSTFIELDS, json_encode ($api_parameters));
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///Lists/Callerlists/CLID'

response_json = requests.delete (url)

/Lists/Callerlists/CLID/Items/EID DELETE

https://api.callone.de/v1000/json///Lists/Callerlists/CLID/Items/EID

Delete a callerlist entry.
NameValueTypeRequ.ValuesDescription
CLIDURLYesUnique callerlist ID.
EIDURLYesUnique callerlist entry ID.
curl -X DELETE "https://api.callone.de/v1000/json///Lists/Callerlists/CLID/Items/EID"
<?php
$url = 'https://api.callone.de/v1000/json///Lists/Callerlists/CLID/Items/EID';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
curl_setopt ($ch, CURLOPT_POSTFIELDS, json_encode ($api_parameters));
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///Lists/Callerlists/CLID/Items/EID'

response_json = requests.delete (url)

/Lists/CostCenters GET

https://api.callone.de/v1000/json///Lists/CostCenters

FIXME
curl -X GET "https://api.callone.de/v1000/json///Lists/CostCenters"
<?php
$url = 'https://api.callone.de/v1000/json///Lists/CostCenters';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///Lists/CostCenters'

response_json = requests.get (url)

/Lists/CostCenters POST

https://api.callone.de/v1000/json///Lists/CostCenters

FIXME
NameValueTypeRequ.ValuesDescription
own_idNumberYesFIXME
descriptionStringYesFIXME
curl -X POST "https://api.callone.de/v1000/json///Lists/CostCenters" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///Lists/CostCenters';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt ($ch, CURLOPT_POSTFIELDS, json_encode ($api_parameters));
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///Lists/CostCenters'

response_json = requests.post (url, data=api_parameters)
Live

The Live API provided you with the information of the layout of the CallOne LiveMonitor and enables you to customize the layout or integrate it with other systems.

/Live/ACD GET

https://api.callone.de/v1000/json///Live/ACD

Live information on ACD agents and skill groups.
curl -X GET "https://api.callone.de/v1000/json///Live/ACD"
<?php
$url = 'https://api.callone.de/v1000/json///Live/ACD';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///Live/ACD'

response_json = requests.get (url)

/Live/ACD/Servicelevel GET

https://api.callone.de/v1000/json///Live/ACD/Servicelevel

FIXME
NameValueTypeRequ.ValuesDescription
timespanString-15
30
45
60
24H
TODAY
YESTERDAY
Select the time range.
curl -X GET "https://api.callone.de/v1000/json///Live/ACD/Servicelevel" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///Live/ACD/Servicelevel?'.http_build_query ($api_parameters, '', '&');

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///Live/ACD/Servicelevel'

response_json = requests.get (url, data=api_parameters)

/Live/Action/UUID/Kick GET

https://api.callone.de/v1000/json///Live/Action/UUID/Kick

Cancel a call.
NameValueTypeRequ.ValuesDescription
UUIDURLYesUnique Call ID.
curl -X GET "https://api.callone.de/v1000/json///Live/Action/UUID/Kick"
<?php
$url = 'https://api.callone.de/v1000/json///Live/Action/UUID/Kick';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///Live/Action/UUID/Kick'

response_json = requests.get (url)

/Live/Action/UUID/Record/START GET

https://api.callone.de/v1000/json///Live/Action/UUID/Record/START

Start call recording.
NameValueTypeRequ.ValuesDescription
UUIDURLYesUnique Call ID.
curl -X GET "https://api.callone.de/v1000/json///Live/Action/UUID/Record/START"
<?php
$url = 'https://api.callone.de/v1000/json///Live/Action/UUID/Record/START';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///Live/Action/UUID/Record/START'

response_json = requests.get (url)

/Live/Action/UUID/Record/STOP GET

https://api.callone.de/v1000/json///Live/Action/UUID/Record/STOP

Stop call recording.
NameValueTypeRequ.ValuesDescription
UUIDURLYesUnique Call ID.
curl -X GET "https://api.callone.de/v1000/json///Live/Action/UUID/Record/STOP"
<?php
$url = 'https://api.callone.de/v1000/json///Live/Action/UUID/Record/STOP';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///Live/Action/UUID/Record/STOP'

response_json = requests.get (url)

/Live/Action/UUID/Stream/START GET

https://api.callone.de/v1000/json///Live/Action/UUID/Stream/START

Start call streaming.
NameValueTypeRequ.ValuesDescription
UUIDURLYesUnique Call ID.
curl -X GET "https://api.callone.de/v1000/json///Live/Action/UUID/Stream/START"
<?php
$url = 'https://api.callone.de/v1000/json///Live/Action/UUID/Stream/START';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///Live/Action/UUID/Stream/START'

response_json = requests.get (url)

/Live/Action/UUID/Stream/STOP GET

https://api.callone.de/v1000/json///Live/Action/UUID/Stream/STOP

Stop call streaming.
NameValueTypeRequ.ValuesDescription
UUIDURLYesUnique Call ID.
curl -X GET "https://api.callone.de/v1000/json///Live/Action/UUID/Stream/STOP"
<?php
$url = 'https://api.callone.de/v1000/json///Live/Action/UUID/Stream/STOP';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///Live/Action/UUID/Stream/STOP'

response_json = requests.get (url)

/Live/Calls GET

https://api.callone.de/v1000/json///Live/Calls

Live information on ongoing calls.
NameValueTypeRequ.ValuesDescription
groupString-service
customer
FIXME
sortString-ddi
dealer_kid
destination
duration
id
kid
service
start_time
status
FIXME
expandString-customer
Additional informations by value.
extensionString-reseller
To be used by resellers only.
curl -X GET "https://api.callone.de/v1000/json///Live/Calls" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///Live/Calls?'.http_build_query ($api_parameters, '', '&');

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///Live/Calls'

response_json = requests.get (url, data=api_parameters)

/Live/EVN GET

https://api.callone.de/v1000/json///Live/EVN

Information on the most recent calls.
NameValueTypeRequ.ValuesDescription
sortString-created
service
FIXME
limitNumber-Limits the maximum number of data records in the result.
offsetNumber-Query starts with the next data record (e.g. 101, if you enter 100).
curl -X GET "https://api.callone.de/v1000/json///Live/EVN" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///Live/EVN?'.http_build_query ($api_parameters, '', '&');

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///Live/EVN'

response_json = requests.get (url, data=api_parameters)

/Live/Reachability GET

https://api.callone.de/v1000/json///Live/Reachability

Live information on the reachability of your lines.
NameValueTypeRequ.ValuesDescription
timespanString-15
30
45
60
24H
TODAY
YESTERDAY
Select the time range.
directionString-IN
OUT
Filters between inbound and outbound calls.
curl -X GET "https://api.callone.de/v1000/json///Live/Reachability" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///Live/Reachability?'.http_build_query ($api_parameters, '', '&');

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///Live/Reachability'

response_json = requests.get (url, data=api_parameters)

/Live/SIP GET

https://api.callone.de/v1000/json///Live/SIP

Live information on SIP users.
curl -X GET "https://api.callone.de/v1000/json///Live/SIP"
<?php
$url = 'https://api.callone.de/v1000/json///Live/SIP';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///Live/SIP'

response_json = requests.get (url)

/Live/WaitDuration GET

https://api.callone.de/v1000/json///Live/WaitDuration

Current average waiting duration of your lines.
NameValueTypeRequ.ValuesDescription
skill_groupNumber-ID of skill group.
routingNumber-Routing ID.
groupNumber-FIXME: (1,10)
curl -X GET "https://api.callone.de/v1000/json///Live/WaitDuration" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///Live/WaitDuration?'.http_build_query ($api_parameters, '', '&');

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///Live/WaitDuration'

response_json = requests.get (url, data=api_parameters)

/Live/WaitList GET

https://api.callone.de/v1000/json///Live/WaitList

Live information on calls that are currently in the waiting queue.
NameValueTypeRequ.ValuesDescription
skill_groupNumber-ID of skill group.
routingNumber-Routing ID.
curl -X GET "https://api.callone.de/v1000/json///Live/WaitList" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///Live/WaitList?'.http_build_query ($api_parameters, '', '&');

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///Live/WaitList'

response_json = requests.get (url, data=api_parameters)

/Live/Wallboard GET

https://api.callone.de/v1000/json///Live/Wallboard

Gives you all information that is included in the wallboard of the LiveMonitor.
NameValueTypeRequ.ValuesDescription
timespanString-15
30
45
60
24H
TODAY
YESTERDAY
Select the time range.
curl -X GET "https://api.callone.de/v1000/json///Live/Wallboard" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///Live/Wallboard?'.http_build_query ($api_parameters, '', '&');

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///Live/Wallboard'

response_json = requests.get (url, data=api_parameters)
Lookup

The lookup API returns informations about a supplied phone number.

/Lookup/ GET

https://connect.callone.io/api/rest/modules/v1///Lookup/

Request information about a phone number.
NameValueTypeRequ.ValuesDescription
numberNumberYesPhone number.
modeStringYesareacode
provider
all
Select requested information.
curl -X GET "https://connect.callone.io/api/rest/modules/v1///Lookup/" -d ""
<?php
$api_parameters = array ();

$url = 'https://connect.callone.io/api/rest/modules/v1///Lookup/?'.http_build_query ($api_parameters, '', '&');

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://connect.callone.io/api/rest/modules/v1///Lookup/'

response_json = requests.get (url, data=api_parameters)
PhoneBook

You can use the PhoneBook API to view, change and add entries to your CallOne phone book.

/PhoneBook/Contacts GET

https://api.callone.de/v1000/json///PhoneBook/Contacts

List all contacts.
NameValueTypeRequ.ValuesDescription
filterString-id
owner_id
owner_type
private
Filters result by value. (FIXME: filter=(owner_id lt/eq/gt id)
sortString-company
gender
firstname
id
lastname
Sorts result by value.
expandString-address
phone
mail
web
note
free
Additional informations by value.
limitNumber-Limits the maximum number of contacts in the result.
offsetNumber-Query starts with the next data record (e.g. 101, if you enter 100).
curl -X GET "https://api.callone.de/v1000/json///PhoneBook/Contacts" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///PhoneBook/Contacts?'.http_build_query ($api_parameters, '', '&');

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///PhoneBook/Contacts'

response_json = requests.get (url, data=api_parameters)

/PhoneBook/Contacts POST

https://api.callone.de/v1000/json///PhoneBook/Contacts

Create a new contact.
NameValueTypeRequ.ValuesDescription
genderString-Frau
Herr
Firma
Defines if contact is female, male or a company.
companyString-Name of company.
positionString-Position of contact (e.g. Head of Customer Care).
titleString-Title of contact.
firstnameString-First name of contact.
lastnameString-Last name of contact.
privateBoolean-false
true
Defines if contact is a private contact (e.g. for certain agent) or a public contact for all users.
owner_typeString-Agent
User
Admin
SuperAdmin
Defines groups of users to own contacts.
owner_idNumber-ID of user for whom the contact is created (private contact).
address1String-Adress field.
address2String-Adress field.
address3String-Adress field.
address4String-Adress field.
phone1Number-Business phone number.
phone2Number-Business phone number.
phone3Number-Private phone number.
phone4Number-Private phone number.
phone5Number-Mobile business phone number.
phone6Number-Mobile private phone number.
phone7Number-Fax business phone number.
phone8Number-Fax private phone number.
phone9Number-Secretariat phone number.
phone10Number-VOIP number.
phone11Number-Main phone number.
mail1String-Field for email address.
mail2String-Field for email address.
url1String-Field for web address.
url2String-Field for web address.
curl -X POST "https://api.callone.de/v1000/json///PhoneBook/Contacts" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///PhoneBook/Contacts';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt ($ch, CURLOPT_POSTFIELDS, json_encode ($api_parameters));
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///PhoneBook/Contacts'

response_json = requests.post (url, data=api_parameters)

/PhoneBook/Contacts/CID DELETE

https://api.callone.de/v1000/json///PhoneBook/Contacts/CID

Delete a contact.
NameValueTypeRequ.ValuesDescription
CIDURLYesContact ID
curl -X DELETE "https://api.callone.de/v1000/json///PhoneBook/Contacts/CID"
<?php
$url = 'https://api.callone.de/v1000/json///PhoneBook/Contacts/CID';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
curl_setopt ($ch, CURLOPT_POSTFIELDS, json_encode ($api_parameters));
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///PhoneBook/Contacts/CID'

response_json = requests.delete (url)

/PhoneBook/Groups GET

https://api.callone.de/v1000/json///PhoneBook/Groups

Gives you the names of groups you have created in your phone book as well as their respective IDs.
curl -X GET "https://api.callone.de/v1000/json///PhoneBook/Groups"
<?php
$url = 'https://api.callone.de/v1000/json///PhoneBook/Groups';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///PhoneBook/Groups'

response_json = requests.get (url)
Routing

The routing API shows you the current routing setup and enables you to change the routing via API.

/Routing/ GET

https://api.callone.de/v1000/json///Routing/

List all routings.
curl -X GET "https://api.callone.de/v1000/json///Routing/"
<?php
$url = 'https://api.callone.de/v1000/json///Routing/';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///Routing/'

response_json = requests.get (url)

/Routing/ POST

https://api.callone.de/v1000/json///Routing/

Create new new routing.
NameValueTypeRequ.ValuesDescription
midNumberYes51
54
64
200
535
Module ID
routing_descriptionString-Description
point_idNumber-Link with Routing Point ID
number_idNumber-Link with Number ID
number_ddi_idNumber-Link with Number DDI ID
var_cost_idNumber-Cost center ID
var_destinationString-Destination Number
point_destinationNumber-Destination Routing Point ID
multi_destinationNumber-Multiple Destination Numbers
play_introNumber-Welcome audio file
play_waitNumber-Waitingqueue audio file
play_whisperingNumber-Whispering audio file
curl -X POST "https://api.callone.de/v1000/json///Routing/" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///Routing/';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt ($ch, CURLOPT_POSTFIELDS, json_encode ($api_parameters));
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///Routing/'

response_json = requests.post (url, data=api_parameters)

/Routing/RID GET

https://api.callone.de/v1000/json///Routing/RID

Show a routing.
NameValueTypeRequ.ValuesDescription
RIDURLYesRouting ID
curl -X GET "https://api.callone.de/v1000/json///Routing/RID"
<?php
$url = 'https://api.callone.de/v1000/json///Routing/RID';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///Routing/RID'

response_json = requests.get (url)

/Routing/RID PATCH

https://api.callone.de/v1000/json///Routing/RID

Update an existing routing.
NameValueTypeRequ.ValuesDescription
RIDURLYesRouting ID
routing_descriptionString-Description
var_cost_idNumber-Cost center ID
var_destinationString-Destination Number
point_destinationNumber-Destination Routing Point ID
multi_destinationNumber-Multiple Destination Numbers
play_introNumber-Welcome audio file
play_waitNumber-Waitingqueue audio file
play_whisperingNumber-Whispering audio file
curl -X PATCH "https://api.callone.de/v1000/json///Routing/RID" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///Routing/RID';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'PATCH');
curl_setopt ($ch, CURLOPT_POSTFIELDS, json_encode ($api_parameters));
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///Routing/RID'

response_json = requests.patch (url, data=api_parameters)

/Routing/RID DELETE

https://api.callone.de/v1000/json///Routing/RID

Delete a routing.
NameValueTypeRequ.ValuesDescription
RIDURLYesRouting ID.
curl -X DELETE "https://api.callone.de/v1000/json///Routing/RID"
<?php
$url = 'https://api.callone.de/v1000/json///Routing/RID';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
curl_setopt ($ch, CURLOPT_POSTFIELDS, json_encode ($api_parameters));
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///Routing/RID'

response_json = requests.delete (url)

/Routing/Numbers GET

https://api.callone.de/v1000/json///Routing/Numbers

Gives you information on all phone numbers set up for inbound calls in your account.
curl -X GET "https://api.callone.de/v1000/json///Routing/Numbers"
<?php
$url = 'https://api.callone.de/v1000/json///Routing/Numbers';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///Routing/Numbers'

response_json = requests.get (url)

/Routing/Points GET

https://api.callone.de/v1000/json///Routing/Points

Gives you information on all routing points set up in your account.
curl -X GET "https://api.callone.de/v1000/json///Routing/Points"
<?php
$url = 'https://api.callone.de/v1000/json///Routing/Points';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///Routing/Points'

response_json = requests.get (url)

/Routing/Points POST

https://api.callone.de/v1000/json///Routing/Points

Create a Routing Point.
NameValueTypeRequ.ValuesDescription
nameStringYesDescription
curl -X POST "https://api.callone.de/v1000/json///Routing/Points" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///Routing/Points';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt ($ch, CURLOPT_POSTFIELDS, json_encode ($api_parameters));
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///Routing/Points'

response_json = requests.post (url, data=api_parameters)

/Routing/Points/RPID DELETE

https://api.callone.de/v1000/json///Routing/Points/RPID

Delete a Routing Point.
NameValueTypeRequ.ValuesDescription
RPIDURLYesRouting Point ID
curl -X DELETE "https://api.callone.de/v1000/json///Routing/Points/RPID"
<?php
$url = 'https://api.callone.de/v1000/json///Routing/Points/RPID';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
curl_setopt ($ch, CURLOPT_POSTFIELDS, json_encode ($api_parameters));
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///Routing/Points/RPID'

response_json = requests.delete (url)

/Routing/Services GET

https://api.callone.de/v1000/json///Routing/Services

FIXME
curl -X GET "https://api.callone.de/v1000/json///Routing/Services"
<?php
$url = 'https://api.callone.de/v1000/json///Routing/Services';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///Routing/Services'

response_json = requests.get (url)
SIP

With the SIP API you can edit SIP users, add new users to the system or change settings such as speed dial. You can also retrieve and change the settings of SIP devices.

/SIP/Devices GET

https://api.callone.de/v1000/json///SIP/Devices

Gives you information on SIP devices that are set up in your account. This includes their respective MAC ID, current firmware version, etc.
curl -X GET "https://api.callone.de/v1000/json///SIP/Devices"
<?php
$url = 'https://api.callone.de/v1000/json///SIP/Devices';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///SIP/Devices'

response_json = requests.get (url)

/SIP/Devices/DID GET

https://api.callone.de/v1000/json///SIP/Devices/DID

FIXME
NameValueTypeRequ.ValuesDescription
DIDURLYesDevice ID
curl -X GET "https://api.callone.de/v1000/json///SIP/Devices/DID"
<?php
$url = 'https://api.callone.de/v1000/json///SIP/Devices/DID';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///SIP/Devices/DID'

response_json = requests.get (url)

/SIP/Devices/DID/FunctionKeys GET

https://api.callone.de/v1000/json///SIP/Devices/DID/FunctionKeys

FIXME
NameValueTypeRequ.ValuesDescription
DIDURLYesDevice ID
curl -X GET "https://api.callone.de/v1000/json///SIP/Devices/DID/FunctionKeys"
<?php
$url = 'https://api.callone.de/v1000/json///SIP/Devices/DID/FunctionKeys';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///SIP/Devices/DID/FunctionKeys'

response_json = requests.get (url)

/SIP/Devices/DID/FunctionKeys POST

https://api.callone.de/v1000/json///SIP/Devices/DID/FunctionKeys

FIXME
NameValueTypeRequ.ValuesDescription
DIDURLYesDevice ID
keyNumberYesKey number, 0-28.
typeStringYesdest
speed
Mapping type, destination or speeddial number.
valueStringYesMapping value.
labelStringYesLabel to be shown on phone.
curl -X POST "https://api.callone.de/v1000/json///SIP/Devices/DID/FunctionKeys" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///SIP/Devices/DID/FunctionKeys';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt ($ch, CURLOPT_POSTFIELDS, json_encode ($api_parameters));
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///SIP/Devices/DID/FunctionKeys'

response_json = requests.post (url, data=api_parameters)

/SIP/Devices/Snom POST

https://api.callone.de/v1000/json///SIP/Devices/Snom

FIXME
NameValueTypeRequ.ValuesDescription
macStringYesMedia-Access-Control address.
descriptionStringYesDescription for device.
curl -X POST "https://api.callone.de/v1000/json///SIP/Devices/Snom" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///SIP/Devices/Snom';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt ($ch, CURLOPT_POSTFIELDS, json_encode ($api_parameters));
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///SIP/Devices/Snom'

response_json = requests.post (url, data=api_parameters)

/SIP/Groups GET

https://api.callone.de/v1000/json///SIP/Groups

Displays all VoIP groups set up in your account (name, ID, destination).
curl -X GET "https://api.callone.de/v1000/json///SIP/Groups"
<?php
$url = 'https://api.callone.de/v1000/json///SIP/Groups';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///SIP/Groups'

response_json = requests.get (url)

/SIP/Numbers GET

https://api.callone.de/v1000/json///SIP/Numbers

FIXME
curl -X GET "https://api.callone.de/v1000/json///SIP/Numbers"
<?php
$url = 'https://api.callone.de/v1000/json///SIP/Numbers';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///SIP/Numbers'

response_json = requests.get (url)

/SIP/Speeddials GET

https://api.callone.de/v1000/json///SIP/Speeddials

Enables you to retrieves the speedial numbers of your account.
curl -X GET "https://api.callone.de/v1000/json///SIP/Speeddials"
<?php
$url = 'https://api.callone.de/v1000/json///SIP/Speeddials';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///SIP/Speeddials'

response_json = requests.get (url)

/SIP/Speeddials POST

https://api.callone.de/v1000/json///SIP/Speeddials

Enables you to create speedial numbers for your account.
NameValueTypeRequ.ValuesDescription
numberNumberYesNumber of the endpoint you would like to set up a speeddial number for.
descriptionStringYesSets the description of the speeddial.
functionStringYesnumber
user
group
routing_point
conference
park
unpark
valet_park
Defines the place, where the speeddial leads. This could be a VoIP user or group, a routing point, a phone number, etc.
destinationNumberYesDefomes the destination of the speeddial. For example, if the function is a VoIP user, the destination would be a VoIP number.
cost_centerNumber-Defines the cost center of the speeddial for your account billing.
curl -X POST "https://api.callone.de/v1000/json///SIP/Speeddials" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///SIP/Speeddials';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt ($ch, CURLOPT_POSTFIELDS, json_encode ($api_parameters));
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///SIP/Speeddials'

response_json = requests.post (url, data=api_parameters)

/SIP/Users GET

https://api.callone.de/v1000/json///SIP/Users

You can use this resource to retrieve information on the SIP user (e.g. ID, username, password, etc.).
curl -X GET "https://api.callone.de/v1000/json///SIP/Users"
<?php
$url = 'https://api.callone.de/v1000/json///SIP/Users';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///SIP/Users'

response_json = requests.get (url)

/SIP/Users POST

https://api.callone.de/v1000/json///SIP/Users

Use this resource to create new SIP users.
NameValueTypeRequ.ValuesDescription
numberNumberYesLast three digits of VoIP endpoint number.
nameStringYesDisplay name.
locationNumber-ID of endpoint location.
user_provided_numberNumber-Number to be transmitted for outgoing calls of the endpoint.
speeddial_numberNumber-Speeddial number for internal calls to the endpoint.
dial_prefix_cityString-City prefix.
dial_prefix_countryString-Country prefix.
cost_centerNumber-ID of cost center for this endpoint.
templateNumber-Template ID from which the configuration should be copied.
curl -X POST "https://api.callone.de/v1000/json///SIP/Users" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///SIP/Users';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt ($ch, CURLOPT_POSTFIELDS, json_encode ($api_parameters));
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///SIP/Users'

response_json = requests.post (url, data=api_parameters)

/SIP/Users/SIPNR PATCH

https://api.callone.de/v1000/json///SIP/Users/SIPNR

Update SIP user.
NameValueTypeRequ.ValuesDescription
SIPNRURLYesSIP User
nameStringYesDisplay name.
user_provided_numberNumber-Number to be transmitted for outgoing calls of the endpoint.
fwNumber-Forward all calls to this destination number.
fw_externalNumber-Forward external calls to this destination number.
fw_internalNumber-Forward interal calls to this destination number.
bobNumber-false
true
Enable Busy-On-Busy.
dndNumber-false
true
Enable Do-Not-Disturb.
inactiveNumber-false
true
Set's the SIP User as inactive.
curl -X PATCH "https://api.callone.de/v1000/json///SIP/Users/SIPNR" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///SIP/Users/SIPNR';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'PATCH');
curl_setopt ($ch, CURLOPT_POSTFIELDS, json_encode ($api_parameters));
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

api_parameters = {}

url = 'https://api.callone.de/v1000/json///SIP/Users/SIPNR'

response_json = requests.patch (url, data=api_parameters)

/SIP/Users/SIPNR DELETE

https://api.callone.de/v1000/json///SIP/Users/SIPNR

Delete SIP user.
NameValueTypeRequ.ValuesDescription
SIPNRURLYesSIP User
curl -X DELETE "https://api.callone.de/v1000/json///SIP/Users/SIPNR"
<?php
$url = 'https://api.callone.de/v1000/json///SIP/Users/SIPNR';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
curl_setopt ($ch, CURLOPT_POSTFIELDS, json_encode ($api_parameters));
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-Type: application/json; charset=utf-8'));
$response_json = curl_exec ($ch);
curl_close ($ch);
?>
import requests

url = 'https://api.callone.de/v1000/json///SIP/Users/SIPNR'

response_json = requests.delete (url)
SMS

You can use the SMS API to send SMS to phone numbers. This can be used to give a customer information about his order state or for authenticating a customer.

/SMS/ POST

https://api.callone.de/v1000/json///SMS/

Send SMS to phone number.
NameValueTypeRequ.ValuesDescription
destinationNumberYesDestination phone number. Value will be checked for valid phone number format and blacklist.
senderStringYesText or phone number which is shown in SMS as sender. No spaces or special characters allowed, maximal length is 16 characters.
textStringYesSMS text with a minimum length of three characters.
curl -X POST "https://api.callone.de/v1000/json///SMS/" -d ""
<?php
$api_parameters = array ();

$url = 'https://api.callone.de/v1000/json///SMS/';

$ch = curl_init ();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt ($ch, CURLOPT_POSTFIELDS, json_encode ($api_parameters));
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_seto