Get project parameters

Reading Time: 4 minutes

Get detailed information about a given project.

Request
Method GET
Resource https://[customer].asp.virtual-call-center.eu/v2/projects/[projectid]
Options N/A
Body N/A
Response
Body Detailed information about the given project, encoded in JSON

Request

Resource parameters

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

Response

Response object

Name Type Comment
dispositions array of objects Array of dispositions associated with the project.
fields array of objects Array of fields associated with the project.

Field object

Name Type Comment
customised string Defines whether this field should appear on an agent’s manual dialing list. Possible values:
– yes
– no
fieldid integer Unique field identifier in VCC’s database.
indexed string Defines whether records can be searched for on VCC Live’s user interface using this field. Possible values:
– yes
– no
label string Field label. It appears on an agent’s manual dialing list.
name string Field name.
type string Field type. Possible values:
– text
– simple (e.g.: combo)
– multiple (e.g.: checkboxes)
values array of objects Field values.

Value object

Name Type Comment
commission integer Agent’s commission, as defined by supervisor.
description string Comments, as provided by supervisor.
export_value string Export value.
fieldid integer Field identifier which this value is connected to.
label string Value label.
name string Value name.
price integer Call center’s commission, as defined by supervisor.
valueid integer Value identifier in VCC’s database.

Disposition object

Name Type Comment
assessment string Disposition assessment:
– success: call recipient reached
– ordered: call recipient reached and call goal achieved
– failed: call recipient not reached
commission integer Call centre’s commission, as defined by supervisor.
description string Disposition comment, as provided by supervisor.
id integer Disposition identifier in VCC’s database.
label string Disposition export value, as provided by supervisor.
mode string Disposition status. Possible values:
– active
– inactive
– deleted
name string Disposition name.
price integer Agent’s commission, as defined by supervisor.
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:
– recall (callback)
– shared_recall (shared callback)
– busy
– limit_exceeded (channel limit exceeded)
– unavailable
– discard
– temporary_not_available
– discard_failed
– dropped
– quota (quota limit exceeded)
– answering_machine
– machine
– robinson
– finished

Example

Request

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

Response body

{
    "response": {
        "fields": [
            {
                "fieldid": 1,
                "name": "name",
                "type": "text",
                "indexed": "yes",
                "customised": "yes",
                "label": "name"
            },
            {
                "fieldid": 2,
                "name": "phone1",
                "type": "text",
                "indexed": "yes",
                "customised": "yes",
                "label": "phone1"
            },
            {
                "fieldid": 3,
                "name": "contract",
                "type": "multiple",
                "indexed": "yes",
                "customised": "no",
                "label": "Contract type",
                "values": [
                    [
                        {
                            "label": "Investment",
                            "name": "Investment",
                            "valueid": 1,
                            "fieldid": 3,
                            "export_value": "Credit",
                            "description": "Account",
                            "commission": 0,
                            "price": 0
                        }
                    ]
                ]
            },
            {
                "fieldid": 4,
                "name": "pay",
                "type": "simple",
                "indexed": "no",
                "customised": "no",
                "label": "Pay type",
                "values": [
                    [
                        {
                            "label": "Cash",
                            "name": "Cash",
                            "valueid": 2,
                            "fieldid": 4,
                            "export_value": "pay_cash",
                            "description": "paid by cash",
                            "commission": 10,
                            "price": 100
                        },
                        {
                            "label": "Bank",
                            "name": "Bank",
                            "valueid": 3,
                            "fieldid": 4,
                            "export_value": "pay_bank",
                            "description": "paid via transfer",
                            "commission": 20,
                            "price": 200
                        },
                        {
                            "label": "Credit card",
                            "name": "Credit card",
                            "valueid": 4,
                            "fieldid": 4,
                            "export_value": "pay_credit",
                            "description": "paid by credit card",
                            "commission": 30,
                            "price": 300
                        }
                    ]
                ]
            },
            {
                "fieldid": 5,
                "name": "adress",
                "type": "text",
                "indexed": "no",
                "customised": "no",
                "label": "Adress"
            }
        ],
        "dispositions": [
            {
                "name": "Callback",
                "assesment": "failed",
                "description": "",
                "recall": 0,
                "status": "recall",
                "price": 0,
                "commission": 0,
                "id": 1,
                "label": "Callback",
                "mode": "active"
            },
            {
                "name": "Shared callback",
                "assesment": "failed",
                "description": "",
                "recall": 0,
                "status": "shared_recall",
                "price": 0,
                "commission": 0,
                "id": 2,
                "label": "Shared callback",
                "mode": "active"
            },
            {
                "name": "Busy",
                "assesment": "failed",
                "description": "",
                "recall": 0,
                "status": "busy",
                "price": 0,
                "commission": 0,
                "id": 3,
                "label": "Busy",
                "mode": "active"
            },
            {
                "name": "Limit exceeded",
                "assesment": "failed",
                "description": "",
                "recall": 0,
                "status": "limit_exceeded",
                "price": 0,
                "commission": 0,
                "id": 4,
                "label": "Limit exceeded",
                "mode": "active"
            },
            {
                "name": "Unavailable",
                "assesment": "failed",
                "description": "",
                "recall": 0,
                "status": "unavailable",
                "price": 0,
                "commission": 0,
                "id": 5,
                "label": "Unavailable",
                "mode": "active"
            },
            {
                "name": "Discard",
                "assesment": "failed",
                "description": "",
                "recall": 0,
                "status": "discard",
                "price": 0,
                "commission": 0,
                "id": 6,
                "label": "Discard",
                "mode": "active"
            },
            {
                "name": "Temporary not available",
                "assesment": "failed",
                "description": "",
                "recall": 0,
                "status": "temporary_not_available",
                "price": 0,
                "commission": 0,
                "id": 7,
                "label": "Temporary not available",
                "mode": "active"
            },
            {
                "name": "Discard (wrong number)",
                "assesment": "failed",
                "description": "",
                "recall": 0,
                "status": "discard_failed",
                "price": 0,
                "commission": 0,
                "id": 8,
                "label": "Discard (wrong number)",
                "mode": "active"
            },
            {
                "name": "Dropped",
                "assesment": "failed",
                "description": "",
                "recall": 86400,
                "status": "dropped",
                "price": 0,
                "commission": 0,
                "id": 9,
                "label": "Dropped",
                "mode": "active"
            },
            {
                "name": "Quota",
                "assesment": "failed",
                "description": "",
                "recall": 0,
                "status": "quota",
                "price": 0,
                "commission": 0,
                "id": 10,
                "label": "Quota",
                "mode": "active"
            },
            {
                "name": "Answering machine",
                "assesment": "failed",
                "description": "",
                "recall": 0,
                "status": "answering_machine",
                "price": 0,
                "commission": 0,
                "id": 11,
                "label": "Answering machine",
                "mode": "active"
            },
            {
                "name": "Machine",
                "assesment": "failed",
                "description": "",
                "recall": 0,
                "status": "machine",
                "price": 0,
                "commission": 0,
                "id": 12,
                "label": "Machine",
                "mode": "active"
            },
            {
                "name": "Robinson list",
                "assesment": "failed",
                "description": "",
                "recall": 0,
                "status": "robinson",
                "price": 0,
                "commission": 0,
                "id": 13,
                "label": "Robinson list",
                "mode": "inactive"
            },
            {
                "name": "Rejected",
                "assesment": "success",
                "description": "The customer is not interested, not live.",
                "recall": 0,
                "status": "finished",
                "price": 0,
                "commission": 0,
                "id": 15,
                "label": "disp_rejected",
                "mode": "active"
            },
            {
                "name": "Possible",
                "assesment": "success",
                "description": "The customer is interested in, but should be recalled later. Please add the reason in description!",
                "recall": 41400,
                "status": "recall",
                "price": 0,
                "commission": 0,
                "id": 16,
                "label": "Possible",
                "mode": "active"
            },
            {
                "name": "Pay",
                "assesment": "ordered",
                "description": "This disposition is used when the customer paid.",
                "recall": 0,
                "status": "finished",
                "price": 500,
                "commission": 50,
                "id": 14,
                "label": "Pay",
                "mode": "active"
            }
        ]
    },
    "errors": []
}

  • Miklos

    It would be great if we could see which disposition states are considered finished.
    At the time of writing this comment i found these:
    Finished:
    ‘discard’,
    ‘discard_failed’,
    ‘quota’,
    ‘machine’,
    ‘robinson’,
    ‘finished’
    Not finished:
    ‘recall’,
    ‘shared_recall’,
    ‘busy’,
    ‘limit_exceeded’,
    ‘unavailable’,
    ‘temporary_not_available’,
    ‘dropped’,
    ‘answering_machine’

    • VCC Live

      Dear Miklós,

      Thank you for your feedback. Our Technical Content Team has looked into this matter and will update this page soon. We will let you know when it’s done.

      Kind regards,
      The VCC Live Team

Subscribe to our newsletter
or Contact us!
Please note that by subscribing to our newsletter, you agree to receive regular email messages from VCC Live® about service related news and updates. By subscribing to our newsletter, you also agree that VCC Live® will use your data in accordance with the applicable Privacy Policy until you unsubscribe from the newsletter.