Call https-Posts API

The HTTPS POST API is used to transmit call information in real time to external customer systems. Call data – such as caller number, dialed number, date, time, and optionally DTMF inputs – is sent via the TENIOS API using HTTPS POST. The transmission occurs either at the beginning or at the end of the connection, and optionally after each call block.

HTTPS POST requests allow you to connect external systems, for example to integrate call counting or reporting on another system. Based on the caller number or a customer/ticket number, call-to-action or screenpop functions can be triggered in your CRM or ERP system. This allows agents to see relevant information such as customer data, ticket details, or call-related notes on their screen before even answering the call.

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.

The HTTPS POST settings are configured per phone number in the routing. For details, see here.

Structure of the post-requests: #

Post on call start #

{
   "requestType": "CALL_START",
   "customerNumber": 200000,
   "accessKey": "XXXXXXXXX",
   "variables": {
      "destination_number": "+4922155400300",
      "correlation_id": "XXXXXXXXX",
      "call_uuid": "XXXXXXXXX",
      "caller_id_number": "+4917012345678"
   }
}

Post after each block #

{
   "requestType": "BLOCK_END",
   "customerNumber": 200000,
   "accessKey": "XXXXXXXXX",
   "variables": {
      "destination_number": "+4922155400300",
      "correlation_id": "XXXXXXXXX",
      "call_uuid": "XXXXXXXXX",
      "caller_id_number": "+49170123456"
   },
   "blockType": "ANNOUNCEMENT"
}

Post on call end #

{
   "requestType": "CALL_END",
   "customerNumber": 20000,
   "accessKey": "XXXXXXXXX",
   "variables": {
      "destination_number": "+4922155400300",
      "correlation_id": "XXXXXXXXX",
      "call_uuid": "XXXXXXXXX",
      "caller_id_number": "+49170123456"
   }
}

Post on intiate call forward #

{
   "requestType": "INITIATE_FORWARD",
   "customerNumber": 200000,
   "accessKey": "XXXXXXXXXX",
   "variables": {
      "destination_number": "+4922155400300",
      "correlation_id": "XXXXXXXXX",
      "call_uuid": "XXXXXXXXX",
      "caller_id_number": "+49170123456"
   },
   "destination": "+492212345678",
   "destinationType": "EXTERNALNUMBER"
}

Post on answering call forward #

{
   "requestType": "FORWARD_ANSWER",
   "customerNumber": 200000,
   "accessKey": "XXXXXXXXXX",
   "variables": {
      "destination_number": "+4922155400300",
      "correlation_id": "XXXXXXXXX",
      "call_uuid": "XXXXXXXXX",
      "caller_id_number": "+49170123456"
   },
   "destination": "+492212345678",
   "destinationType": "EXTERNALNUMBER"
}