List records
List records of a given project.
Note: When using the resource, you can get up to the first 10 items of the full list.
| Request | |
|---|---|
| Method | GET |
| Resource | https://[customer].asp.virtual-call-center.eu/v2/projects/[projectid]/records |
| Options | start, num, fieldname, value, callable, create_date |
| Body | N/A |
| Response | |
| Body | Array of records filtered by options, encoded in JSON. |
Request
Resource parameters
| Name | Type | Mandatory | Comment |
|---|---|---|---|
| customer | string | yes | Your call center’s identifier (also called as account or subdomain). |
| projectid | integer | yes | Unique project identifier. |
Options
| Name | Type | Comment |
|---|---|---|
| fieldname | string | Result set can be filtered by fieldname and value parameters. Fieldname should be an indexed field, and can only be used in conjunction with the ‘value’ parameter. |
| num | integer | Specifies the maximum number of records to be returned. |
| start | integer | Specifies the offset of the first record. |
| value | string | Can only be used in conjunction with the ‘fieldname’ parameter. Searches with value% instead of %value%. |
| callable | boolean | Result set can be filtered by callable parameter. If set as true, it will show the number of all records that are callable; if set as false, it will show the number of all records that are not callable. |
| create_date | string | The time and date when the record was created. Format: YYYY-MM-DD |
Response
Response object
| Name | Type | Comment |
|---|---|---|
| id | integer | Unique record identifier. |
| name | string | Value of the record’s ‘name’ field (usually the customer’s name). |
| create_date | string | The time and date when the record was created. Format: YYYY-MM-DD hh:mm:ss |
| create_date_utc | string | The time and date when the record was created in UTC. Format: YYYY-MM-DD hh:mm:ss |
Example
URL: https://mycc.asp.virtual-call-center.eu/v2/projects/134/records?fieldname=age&value=36
{
"response": {
"rows": [
{
"id": 1,
"name": "Stephen Green",
"create_date": 2016-07-11 15:10:17,
"create_date_utc": 2016-07-11 15:10:17
},
{
"id": 2,
"name": "Jack Wallis",
"create_date": 2016-07-11 15:15:21,
"create_date_utc": 2016-07-11 15:15:21
},
{
"id": 3,
"name": "Elizabeth Shawn",
"create_date": 2016-07-12 16:11:31,
"create_date_utc": 2016-07-12 16:11:31
}
],
"totalCount": 3
},
"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.