Outbound Calls

With VoiceBooker it is also possible to place calls, i.e., calling customers that can be used to perform for several tasks such as:

informing them automatically about appointment changes,
actively shedule appointments,
informing them about contract changes, upgrades etc.,
taking surveys etc.

In order to place calls, you simply make a POST API Rest request to the following endpoint:

https://voicebooker.de/app/api/v1/makeCall

with the following header data

Content-Type: application/json
Token: <token>

and the following JSON data in the body:

{
    "dest": "+49-351-123456789",
    "botId": "<id>",
    "sipAccountId": "<id>",
    "startTimeout": 10,
    "state": {
        "customerId": "xyz..."
        ...
    }
}

Parameters

Parameter	Description
dest	The number that should be called in E.164 format
botId	The id of the bot that should be used for the call
sipAccountId	The SIP account that should be used to place. The number of this account will appear on the callees display as caller number
startTimeout	The number in seconds the bot should wait before starting talking to allow the callee to talk first when he/she picked up the call
state	state data that can be used in order to then feed webhooks/API calls to retrieve certain customer data such as a customer ID during the call

The REST-API call will return a callRequestId that can be used for webhook calls that will be triggered if the call succeeded or failed etc.