Developer Guides Database API Database Manage RecordsAdd record

Add record

Add one or more new records to a project database.

If the value field (that can handle only one value) contains text, then:

it finds the field value based on the text input, and sets it (based on the id)
if it does not find the field value, then it automatically creates a new field value

If the value field (that can handle more than one values) contains text, then:

it attempts to divide the text separated by the “|” character
if it doesn’t find any “|” character, then it handles it as one value

The followings apply to each separated values:

it finds the field value based on the text input, and sets it (based on the id)
if it does not find the field value, then it automatically creates a new field value

Request
Method	POST
Resource	https://[customer].asp.virtual-call-center.eu/v2/projects/[projectid]/records
Options	N/A
Body	Customized data, encoded in JSON.
Response
Body	States whether the request is successful or not.

Request

Resource parameters

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

Request object

Name	Type	Mandatory	Comment
contacts	object	no	Contains all contact data related to the client.
disposition	object	no	Disposition for the given record to be set.
form	object	yes	The record’s customized data, such as name, telephone number, address, city, likes, etc. can be set via the form key. If simple or multiple values are set, use ‘valueid’.
phone_field	srting	no	Which telephone number should be called next. Possible values: phone1, phone2…phone9
next_calldate	string	no	This is the next time the record is due to be called, in YYYY-MM-DD hh:mm:ss format.
premium	object	no	Agent and call centre commissions.

Note: If there’s a next_calldate provided in the disposition object, then it overrides the request object’s next_calldate command, as the disposition object’s next_calldate is positioned at a higher priority.

Contacts object

Name	Type	Mandatory	Comment
email	string	no	Email of the contact.
name	string	no	Name of the contact.
phone	string	yes	Phone number of the contact.
title	string	no	Title of the contact e.g.: supervisor, Head of Customer Service.

Premium object

Name	Type	Mandatory	Comment
commission	string	no	Agent’s commission value connected to the record.
price	string	no	Call centre commission value connected to the record.

Disposition object

Name	Type	Mandatory	Comment
dispositionid	integer	yes	Unique disposition identifier.
next_calldate	string	no	If call-back or shared call-back type dispositions are set, this is the next time the record is due to be called, in YYYY-MM-DD hh:mm:ss format.
userid	string	yes	Unique user identifier.
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

Response

Response object

Name	Type	Comment
response	array	Unique ‘numberid'(s) of the inserted record(s).

Example – Adding a Record

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

Request body

{
    "next_calldate": "2020-11-11 11:11:11",
    "phone_field": "phone4",
    "form": {
        "name": "Peter Green",
        "city": "Budapest",
        "likes": "sports|movies"
    },
    "contacts": {
        "1": {
            "title": "Supervisor",
            "name": "Peter Green",
            "phone": "3619997400",
            "email": "[email protected]"
        },
        "4": {
            "phone": "3619996400"
        }
    },
    "premium": {
        "price": "100",
        "commission": "50"
    },
    "disposition": {
        "dispositionid": "1",
        "userid": "7",
        "next_calldate": "2015-07-20 10:26:55"
    }
}

Response body

{
     "response": [6],
     "errors": []
}

Example – Adding Multiple Records

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

Request body

[
{
    "next_calldate": "2020-11-11 11:11:12",
    "phone_field": "phone4",
    "form": {
        "name": "Peter Green",
        "city": "Budapest",
        "likes": "sports|movies"
    },
    "contacts": {
        "1": {
            "title": "Supervisor",
            "name": "Peter Green",
            "phone": "3619997400",
            "email": "[email protected]"
        },
        "4": {
            "phone": "3619996400"
        }
    },
    "premium": {
        "price": "100",
        "commission": "50"
    },
    "disposition": {
        "dispositionid": "1",
        "userid": "7",
        "next_calldate": "2015-07-20 10:26:55"
    }
},
{
    "next_calldate": "2020-11-11 11:11:13",
    "phone_field": "phone4",
    "form": {
        "name": "Rachel Smith",
        "city": "London",
        "likes": "books|gadgets"
    },
    "contacts": {
        "1": {
            "title": "QA Assistant",
            "name": "Rachel Smith",
            "phone": "449997400",
            "email": "[email protected]"
        },
        "4": {
            "phone": "449997400"
        }
    },
    "premium": {
        "price": "100",
        "commission": "50"
    },
    "disposition": {
        "dispositionid": "1",
        "userid": "7",
        "next_calldate": "2015-07-21 15:26:55"
    }
}
]

Response body

{
"response":[7,8],
"errors":[]
}

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.