Voice Call Settings

Entity description

A VoiceCallSetting entity represents the configuration settings for handling voice calls, including call forwarding preferences, staff availability, and voice scripts for different call stages. It also allows integration with external AI apps for advanced call handling.

Properties

Name	Description	Type	Example
uid	The unique identifier of the VoiceCallSetting entity	string	`56ah3478b56c`
staff_uid	The unique identifier of the staff receiving the forwarded call	string	`5ya4gbwm2c3qic8`
forward_number	The phone number of the staff receiving the forwarded call	string	`180348567634`
dedicated_number	The dedicated number of the business receiving calls from clients	string	`12845783457`
forwarding_enabled	Indicates if voice call forwarding is enabled	boolean	`true`
call_forwarding_policy	Specifies the conditions under which calls are forwarded (`ALWAYS`, `WORK_HOURS`, `NEVER`)	string	`WORK_HOURS`
staff_weekly_availability_uid	The unique identifier representing the staff member's weekly availability	string	`0c4ac9717ab26f56`
call_timeout_sec	Call ringing timeout in seconds	number	`20`
voice_scripts	Configuration of voice messages played to callers during different call stages	object	See Voice Scripts below
external_app_config	Configuration for an external AI app managing the voice call	object	See External App Config below
created_at	The date and time when the VoiceCallSetting entity was created	string	`2024-01-01T09:00:00Z`
updated_at	The date and time when the VoiceCallSetting entity was last updated	string	`2024-03-20T12:34:56Z`
deleted_at	The date and time when the VoiceCallSetting entity was deleted (null if not deleted)	string	`null`

Voice Scripts

Name	Description	Type	Example
greeting_message	The greeting message played to the caller	object	`{ "message": "Hi, The call will be forwarded soon, please wait.", "enabled": true }`
missed_call_message	The message played when the call is missed	object	`{ "message": "Sorry, please try again later.", "enabled": false }`

External App Config

Name	Description	Type	Example
app_name	The name of the external app	string	`my.pa`
full_url	The endpoint related to the external app	string	`https://ww.example.com/my/pa/ncco`
method	The HTTP method to be used (`GET`, `POST`)	string	`GET`

Example

{
  "uid": "56ah3478b56c",
  "staff_uid": "5ya4gbwm2c3qic8",
  "forward_number": "180348567634",
  "dedicated_number": "12845783457",
  "forwarding_enabled": true,
  "call_forwarding_policy": "WORK_HOURS",
  "staff_weekly_availability_uid": "0c4ac9717ab26f56",
  "call_timeout_sec": 20,
  "voice_scripts": {
    "greeting_message": {
      "message": "Hi, The call will be forwarded soon, please wait.",
      "enabled": true
    },
    "missed_call_message": {
      "message": "Sorry, please try again later.",
      "enabled": false
    }
  },
  "external_app_config": {
    "app_name": "my.pa",
    "full_url": "https://ww.example.com/my/pa/ncco",
    "method": "GET"
  },
  "created_at": "2024-01-01T09:00:00Z",
  "updated_at": "2024-03-20T12:34:56Z",
  "deleted_at": null
}