Developer Guides Webhook Async Webhook RequestsCall Disposition (Async)

Call Disposition (Async)

When a disposition is set, the following object is sent to your site, encoded in JSON. For details about system default dispositions, see Dispositions.

Note: A Webhook request is only triggered if an agent user or the dialer sets a disposition. An admin or supervisor user setting a disposition will not generate a Webhook request.

Request Object
Disposition object
Client Data object
Contacts object
Sample Request Body
Capturing Call Recording URL

Request Object

Name	Type	Comment
agent_description	string	Comment added by the agent.
agentName	string	The name of the agent.
client_data	object	Custom data object, including contacts.
closed	integer	Shows that the record is closed or the PPD dialer is going to call it later. Possible values: – 1 – 0
create_time	string	Time of disposition setting in yyyy-mm-dd hh:mm:ss format.
destination	string	Called party’s phone number.
direction	string	Direction of the call that is terminated with the disposition: – in – out
disposition	object	Disposition object.
first_outbound_call_attempt	string	Time of the first call attempt, regardless of whether the call was successful or not. Format: yyyy-mm-dd hh:mm:ss
next_calldate	string	Time of next call scheduled for the record
nextContactId	integer	The ID of the next contact
numberid	integer	Record identifier.
phone_id	integer	Phone’s identifier.
projectid	integer	Project identifier.
projectName	string	The name of the project.
source	string	Calling party’s phone number.
sum_attempted_calls	integer	Total number of call attempts.
teamids	array of integers	Array of teamids.
timestamp	string	Time of disposition setting in ISO 8601 format.
userid	integer	Agent identifier.
username	string	Agent username.
uuid	string	Call identifier.
call_start_time	string	Time of the call’s start.
call_end_time	string	Time of the call’s end.
call_start_time_iso	string	Time of the call’s start in ISO 8601 format..
call_end_time_iso	string	Time of the call’s end in ISO 8601 format.
project_fields	object	The values of the project fields.
user_email	string	The user’s email address.

Disposition object

Name	Type	Comment
assesment	string	Disposition assessment: – success: call recipient reached and call goal achieved – ordered: call recipient reached – failed: call recipient not reached
callback	integer	Disposition Webhook attribute. Possible values: – 1 – 0
comission_collector	integer	Disposition commission collection possibility attribute. Possible values: – 0 – 1
comment_mode	string	Defines the possibility for agents to write comments. Possible values: – allow – force – disable
commission	integer	Call centre’s commission, as defined by supervisor.
default	string	Disposition system attribute. Possible values: – yes – no
description	string	Disposition comment, as provided by supervisor.
hide_history	integer	Disposition hide possibility attribute. Possible values: – 0 – 1
id	integer	Disposition identifier in VCC’s database.
instant	string	Disposition auto-save possibility attribute. Possible values: – yes – no
label	string	Disposition export value, as provided by the supervisor.
mode	string	Disposition status. Possible values: – active – inactive – deleted
name	string	Disposition name.
price	integer	Agent’s commission, as defined by supervisor.
quota	string	Disposition quota attribute. Possible values: – yes – no
recall	integer	The default call-back time, in seconds, as defined by the supervisor for the given disposition. It is set only if the status is ‘recall’ or ‘shared_recall’.
status	string	Disposition type, specifying the actual status of the record. Possible values: see on the link (status key).

Client Data object

Name	Type	Comment
phone1	string	First phone number provided for the record
name	string	Name of the record
contacts	object	Contacts object, including contact data.

This object can include additional data that was added by the users via VCC Live interface or API. Additional data elements are either in string or array format. In case the additional data element is an array, it includes the following attributes:

Name	Type	Comment
valueid	integer	Value ID
fieldid	integer	Field ID
label	string	Label of the value
export_value	string	Export value
description	string	Description of the value

Contacts object

Name	Type	Comment
name	string	Name of contact
phone	string	Phone number of contact
email	string	Email address of contact
title	string	Title of contact
try_before_reach	integer	Number of call attempts before contact is reached.

Sample Request Body

{
    "disposition": {
        "name": "Successful",
        "assesment": "ordered",
        "status": "finished",
        "price": 0,
        "commission": 0,
        "description": "",
        "label": "",
        "recall": 0,
        "id": 14,
        "mode": "active",
        "quota": "no",
        "instant": "no",
        "default": "no",
        "commission_collector": 0,
        "hide_history": 0,
        "comment_mode": "allow",
        "callback": 1
    },
    "agent_description": "test",
    "closed": 0,
    "description": "test",
    "call_start_time": "2023-08-12 14:20:38",
    "call_start_time_iso": "2023-08-12T14:20:38+02:00",
    "call_end_time": "2023-08-12 14:21:38",
    "call_end_time_iso": "2023-08-12T14:21:38+02:00",
    "first_outbound_call_attempt": "2023-01-16 09:20:23",
    "next_calldate": "2023-08-17 15:30:00",
    "phone_id": 1,
    "sum_attempted_calls": 1,
    "direction": "out",
    "source": "3617777777",
    "project_fields": {
        "projectId": 1040,
        "values": {
            "Department": "telesales"
        }
    },
    "destination": "1234",
    "create_time": "2015-11-12 10:32:26",
    "uuid": "a7587a1a-2581-4dfe-b9eb-6a8ddb7caf0e",
    "projectid": 4,
    "projectName": "Test",
    "numberid": 25,
    "username": "rachel.smith",
    "user_email": "[email protected]",
    "agentName": "Rachel Smith",
    "nextContactId": null,
    "userid": 26,
    "teamids": [
        1
    ],
    "client_data": {
        "email": "[email protected]",
        "scenario": [
            {
                "valueid": 3,
                "fieldid": 7,
                "label": "Success",
                "export_value": "",
                "description": "1"
            }
        ],
        "name": "Rachel Smith",
        "amount": "100000",
        "pci_currency": [
            {
                "valueid": 8,
                "fieldid": 3,
                "label": "usd",
                "export_value": null,
                "description": ""
            }
        ],
        "phone1": "3630000000",
        "termekek": [
            {
                "valueid": 12,
                "fieldid": 10,
                "label": "Ticket",
                "export_value": "100000",
                "description": ""
            }
        ],
        "contacts": {
            "1": {
                "name": null,
                "phone": "3600000000",
                "email": null,
                "title": null
            }
        }
    },
    "timestamp": "2015-11-12T10:32:26+01:00"
}

Capturing Call Recording URL

You can send with the help of the call disposition webhook the URL of the call recording that was generated for the given call. In the webhook template, you need to add the following (“recordingfileUrl” can be replaced with any attribute of your choice). You need to populate TOKEN with a valid VCC Live Database API token and replace ‘myaccount’ with your account name:

“recordingfileUrl”: "https://myaccount:[email protected]/v2/cdr/current year/current month/current day/uuid/voicefile"

current year: replace with {{call_end_time|date(‘Y’)}}
current month: replace with {{call_end_time|date(‘m’)}}
current day: replace with {{call_end_time|date(‘d’)}}
uuid: replace with {{ uuid }}

Note: Keep in mind to whitelist the IPs in VCC from which you would like to retrieve the voice files.

Comments

Can’t find what you need? Use the comment section below to connect with others, get answers from our experts, or share your ideas with us.

There are no comments yet.

Click here to cancel reply.