Fragen? 0800 55400300
View Categories

Voice-API Overview

3 min read

The TENIOS Voice API enables you to operate your own voice applications using common web technologies (http (s), REST) in the TENIOS Cloud Communications platform. The TENIOS Voice API provides you with numerous functions: receiving calls, generating outgoing calls, connecting callers, voice recording, IVR menus, SIP trunks, chatbot telephony (VBC), speech recognition (ASR) and speech synthesis (TTS ).

You can find code examples for implementation on our Github page.

Requirements for the connection to the TENIOS VOICE API

  • The TENIOS Voice API is only accessible using HTTPS . To ensure data protection, unencrypted HTTP is not supported.
  • The TENIOS Voice API currently only supports connections via TLS 1.2
  • To establish a secure connection, you need to make sure that the Chain of trust is intact.

Base URL

All URLs referenced in the documentation have the following base:

 

POST https://api.tenios.com/

Authentication

All requests to the TENIOS API are authenticated using the access_key . You can find the key in the portal under My Account / General Settings.

 

{
   "access_key": "c0b93a5e-4ce0-4adb-940e-5079f2abbcb4"
}

 

Content-Type

The TENIOS REST-API is provided via HTTPS. Basically all requests are HTTP-POST requests. All POST requests must contain a valid object in accordance with JSON notation and the Content-Type header must be set to the value application/json. All TENIOS API endpoints return a response in JSON format and have the Content-Type header set to application/json.

API Response

The following table lists the most common HTTP error responses:

Code Nachricht Anmerkungen
200 OK Standard response for successful HTTP requests.
400 Bad Request The server cannot or will not process the request due to an apparent client error (e.g invalid JSON)
403 Forbidden Request with an invalid access key.
404 Not Found The requested resource could not be found due to unknown methods.
500 Internal Server Error Request fails due to an internal error in the TENIOS API.

Data formats

Date & time zone

The TENIOS Voice API accepts date parameters in UTC format. The following table shows the valid date formats that can be used in a request:

Format Anmerkung
2016-04-11T09:00:00.000Z Date without time zone, UTC
2016-04-11T09:00:00.000+10:00 Date with time zone.
2016-04-11T09:00:00.000-06:00 Date with time zone.

The server always returns the response in the UTC format without timezone: 

 2016-04-11T09:00:00.000Z
If a date parameter contains an invalid date format, the server responds with a CDR_DATE_PARSE_ERROR error.

Request example

{
   "access_key": "c0b93a5e-4ce0-4adb-940e-5079f2abbcb4",
   "start_date_from": "2015-05-01T00:00:00.001Z",
   "start_date_to": "2016-09-02T00:00:00.001Z"
}

Functions

The TENIOS Voice API has the following functions. Click a link for more information on how to interact with the REST API.

Phone number

Call

ACD

Cloud-PBX

Call Control

Call https-POSTs

TOP