Fragen? 0800 55400300
View Categories

Call Recording API

2 min read

The recording API allows to start and stop recording of ongoing calls. It is possible to start and stop a recording multiple times on the same call. So it is possible to record only certain sections of a call. The recorded files will be transferred to the customers sftp-server. see: www.tenios.de/en/doc/recordings

Start call recording:

Start call recording for the call with the provided call_uuid.

POST https://api.tenios.com/record-call/start

 

Request Parameter:

access_key String TheAPI access Key. It can be found in the menu MY ACCOUNT–>General Settings in the section API in the customer portal.
call_uuid String The uuid of the call that should be recorded.
record_caller String A Boolean value that specifies whether the caller’s voice channel should be recorded. Optional. Default: true
record_callee String A boolean value that specifies whether the called party’s voice channel should be recorded. Optional. Default: true

Example of a successful request:

Request:

{
   "access_key": "XXXXX-XXXX-XXXXXX",
   "call_uuid": "e3163745-1fbe-4b28-bf58-6e6030ca8ace"
}

API Response:

HTTP Status Code: 200 (OK)

{
   "recording_uuid": "8101fcb3-3843-4db3-9829-f7ab586625fe"
}

 

Request:

{
   "access_key": "XXXXX-XXXX-XXXXXX",
   "call_uuid": "1f9ff5f2-06a6-4d71-bc6a-3dd32b36f84f",
   "record_caller": false,
   "record_callee": true
   
}

API Response:

HTTP Status Code: 200 (OK)

{
   "recording_uuid": "f57135d7-2e5c-44dd-bd82-bc1693596260"
}

 

Examples of invalid requests:

INVALID_VALUE
DieserThis error is returned if a wrong or invalid call_uuid provided.

Request:

{
   "access_key": "XXXXX-XXXX-XXXXXX",
   "call_uuid": "a"
}

API Response:

HTTP Status Code: 400 (Bad Request)

{
   "error_code": "INVALID_VALUE",
   "error_message": "Invalid parameter type or format",
   "fields": [
      "call_uuid"
   ]
}

Stop call recording:

Stop call recording for the call with the provided call_uuid.

POST https://api.tenios.com/record-call/stop

 

Request Parameter:

access_key String The API Access Key. It can be found in the menu MY ACCOUNT –> General Settings in the section API in the customer portal.
recording_uuid String The uuid of the recording that should be stopped.

Example of a successful request:

Request:

{
   "access_key": "XXXXX-XXXX-XXXXXX",
   "call_uuid": "e3163745-1fbe-4b28-bf58-6e6030ca8ace",
   "recording_uuid": "1f92df20-f643-4105-bdbf-104c98aba611"
}

API Response:

HTTP Status Code: 200 (OK)

{
   "success": "true"
}

Examples of invalid requests:

INVALID_VALUE
This error is returned if a wrong or invalid recording_uuid was provided.

Request:

{
   "access_key": "XXXXX-XXXX-XXXXXX",
   "call_uuid": "e3163745-1fbe-4b28-bf58-6e6030ca8ace",
   "recording_uuid": "a"
}

API Response:

HTTP Status Code: 400 (Bad Request)

{
"error_code": "INVALID_VALUE",
"error_message": "Invalid parameter type or format",
"fields": [
"recording_uuid"
]
}

Retrieve recording:

Retrieve a call recording for the call with the provided call_uuid.

POST https://api.tenios.com/record-call/retrieve

 

Request Parameter:

access_key String The API Access Key. It can be found in the menu MY ACCOUNT –> General Settings in the section API in the customer portal.
recording_uuid String The uuid of the recording that should be retrieved.
Example of a successful request:

Request:

{
   "access_key": "XXXXX-XXXX-XXXXXX",  
   "recording_uuid": "1f92df20-f643-4105-bdbf-104c98aba611"
}

API Response:

HTTP Status Code: 200 (OK)

The response will be an octet stream with content-Type application/octet-stream; charset=UTF-8

Examples of invalid requests:

INVALID_VALUE
This error is returned if a wrong or invalid recording_uuid was provided.

Request:

{
   "access_key": "XXXXX-XXXX-XXXXXX",
   "call_uuid": "e3163745-1fbe-4b28-bf58-6e6030ca8ace"
}

API Response:

HTTP Status Code: 400 (Bad Request)

{
"error_code": "INVALID_VALUE",
"error_message": "Invalid parameter type or format",
"fields": [
"recording_uuid"
]
}

If the recording_uuid is syntactically correct, but no recording could be found, the HTTP status code is:  

HTTP Status Code: 404 (Not found)

[/su_spoiler][/su_accordion]

 

TOP