Fragen? 0800 55400300
View Categories

Call Control Voice API

Table of Contents

With the Call Control Voice API it is possible to control calls controlled via the Call Control API with additional methods. HTTPS POST requests are sent from IP address 80.239.139.193. Please ensure that this IP address is whitelisted in your firewall so that call data can reach your system.

Interrupt current block: #

With this method, the currently executing block is interrupted. Not all blocks can be interrupted, if this is not possible, an appropriate error message is returned.

POST https://api.tenios.com/interrupt-ecc-block

 

Request parameter: #

access_key The access key for the API. This can be found in the customer portal under the menu item MY ACCOUNT/ General settings in the API section.
call_uuid The UUID of the call on which to break the currently running block.

Response parameter: #

success boolean true on success, otherwise an error message.

 

Example for an successful request: #

Request: #

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

API Response: #

HTTP Status Code: 200 (OK)

{
   "success": true
}

Examples for invalid requests: #

INVALID_FIELD_1
This error is returned when invalid input is specified for the parameter.

Request: #

{
   "access_key": "XXXXX-XXXX-XXXXXX",
   "call_uuid": "XXXXX-XXXX-XXXXXX",
   "destination_type": "EXTERNAL",
   "destination": "+4922155400300"
}

API Response: #

HTTP Status Code: 400 (Bad Request)

{
   "success": false,
   "error_code": "INVALID_VALUE",
   "error_message": "Invalid parameter type or format",
   "fields": [
      "destination_type"
   ]
}
INVALID_FIELD_2
This error is returned when incorrect or invalid input is specified for the parametercall_uuid.

Request: #

{
   "access_key": "XXXXX-XXXX-XXXXXX",
   "call_uuid": "123456789",
   "sip_uri": "sip:4044@8.8.8.8:5060;user=phone"
}

API Response: #

HTTP Status Code: 400 (Bad Request)

{
   "error_code": "INVALID_FIELD",
   "error_message": "Invalid 'call_uuid' input parameter. Invalid value - '1234567890'.",
   "fields": [
      "call_uuid"
   ]
}
INVALID_JSON
This error is returned when a parameter is missing.

Request: #

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

API Response: #

HTTP Status Code: 400 (Bad Request)

{
   "error_code": "INVALID_JSON",
   "error_message": "An invalid JSON object was provided in the request body.",
   "fields": []
}
CALL_UUID_NOT_FOUND
This error is returned if the call’s uuid was not found

Request: #

{
   "access_key": "XXXXX-XXXX-XXXXXX",
   "call_uuid": "c0b93a5e-4ce0-4adb-940e-5079f2abbcb4"
}

API Response: #

HTTP Status Code: 400 (Bad Request)

{
   "success": false,
   "error_code": "CALL_UUID_NOT_FOUND",
   "error_message": "The call wasn't found",
   "fields": [
      "call_uuid"
   ]
}
What are your Feelings
TOP