Batch dispositions modification

Developer Guides Database API DatabaseBatch dispositions modification

Batch dispositions modification

Modify multiple dispositions in batch mode within a project.

Note: There is no limit on how many batches you can submit to update. If it fails due to timeout, please try to limit the query to fewer data.

Request
Method	PUT
Resource	https://[customer].asp.virtual-call-center.eu/v2/projects/[projectid]/records/dispositions
Options	N/A
Body	Disposition objects, encoded in JSON.
Response
Body	Array of partial results by elements.

Request

Resource parameters

Name	Type	Mandatory	Comment
customer	string	yes	Your call centre’s unique identifier (subdomain).
projectid	integer	yes	Unique project identifier.

Request object

Name	Type	Mandatory	Comment
avoid_in_call	bool	no	Ignores all records being handled by agents (prework, in call, afterwork).
disposition	object	no	Key value pairs that should be set for every record, specified by an ‘element’ object.
elements	array of objects	yes	Array of disposition objects to be set.

Element object

Name	Type	Mandatory	Comment
description	string	no	Description added by the supervisor.
dispositionid	string	no	Unique disposition identifier.
next_calldate	string	no	Defines callback time in YYYY-MM-DD HH:MM:SS format.
numberid	string	yes/no	Unique record identifier specifying a record to be set. Either ‘search’ or ‘numberid’ can be set.
search	object	yes/no	Specifies a record to which key value pairs should be applied to. Either ‘search’ or ‘numberid’ can be set. Possible values: – numberid: Unique record identifier. – pref_userid: User identifier to whom the disposition is linked. – act_status: Disposition identifier which the disposition is linked. If more than one ‘search’ object is added, the search method will be ‘OR’. If more than one search criteria is defined within the ‘search’ object, the search method will be ‘AND’.
userid	string	no	User identifier to whom the disposition is linked.
sendDispositionMessages	boolean	no	If SMS and/or email sending is set up for the disposition, the SMS and/or email will be sent. Values: true, false

Disposition object

Name	Type	Mandatory	Comment
description	string	no	Description added by the supervisor.
dispositionid	integer	no	Unique disposition identifier.
next_calldate	string	no	Defines callback time in YYYY-MM-DD HH:MM:SS format.
userid	integer	no	User identifier to whom the disposition is linked.

Response

Array of partial results by elements.

Example

URL: https://mycc.asp.virtual-call-center.eu/v2/projects/17/records/dispositions

Request body

{
    "elements": [
        {
            "numberid": "1",
            "dispositionid": "1",
            "userid": "22",
            "next_calldate": "2017-10-10 11:00:00",
            "description": "High school graduate"
        },
        {
            "search": {
                "name": "Green"
            }
        }
    ],
    "disposition": {
        "dispositionid": "2",
        "userid": "7",
        "next_calldate": "2017-09-10 12:00:00",
        "description": "University degree"
    },
    "avoid_in_call": true
}

Response body

{
    "errors": [],
    "response": {
        "0": true,
        "1": true
    }
}

Response body if partially successful

{
    "errors": [
        {
            "errorcode": 417,
            "errormessage": "error.missing_numberid_or_search",
            "index": 1
        }
    ],
    "response": {
        "0": true,
        "2": true
    }
}

Back to Support and Learning Center

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.