Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Returns the data collections configured for the specified service

HTTP GET /livechat/getDataCollection/:serviceId

Path Variables:

Name

Mandatory

Type

Description

serviceId

YES

STRING

Unique service identifier

Response:

Type: JSONP

Name

Type

Description

result

BOOLEAN

If true, the service response was performed correctly

datacollections

NULL / OBJECT

An object that contains all the data collections objects configured for the service

error

NULL / STRING

Contains the error description if an error has occurred in the request

Example:

Request

http://<hostname>:<port>/livechat/getDataCollection/LiveChat_Popup

Response

{ 
   "result":true,
   "datacollections":{ 
      "67990d2d-5d35-4d7d-93ac-df3d9edb636d":{ 
         "datacollection":[ 
            { 
               "_id":"5c6e700404445e26d8dbeee4",
               "dc_type":"nickname",
               "label":"Nickname",
               "isMandatory":true,
               "isVisibleAgent":true,
               "isVisibleCustomer":true,
               "isEditable":true,
               "custom_regexp":"",
               "value":"",
               "name":"nickname",
               "mode":"manual"
            },
            { 
               "_id":"5c6e700404445e26d8dbeee3",
               "dc_type":"name",
               "label":"Name",
               "isMandatory":false,
               "isVisibleAgent":true,
               "isVisibleCustomer":true,
               "isEditable":true,
               "custom_regexp":"",
               "value":"",
               "name":"name",
               "mode":"manual"
            },
            { 
               "_id":"5c6e700404445e26d8dbeee2",
               "dc_type":"surname",
               "label":"surname",
               "isMandatory":false,
               "isVisibleAgent":true,
               "isVisibleCustomer":true,
               "isEditable":true,
               "custom_regexp":"",
               "value":"",
               "name":"surname",
               "mode":"manual"
            }
         ],
         "_id":"5c6e700404445e26d8dbeee1",
         "id":"67990d2d-5d35-4d7d-93ac-df3d9edb636d",
         "title":"Anagrafica #1",
         "dc_mode":"chat",
         "next":"",
         "__v":0
      },
      "fc0450c8-4b2c-42b3-b8c9-04b672ca4a90":{ 
         "datacollection":[ 
            { 
               "_id":"5c6e700404445e26d8dbeee8",
               "dc_type":"email",
               "label":"Email",
               "isMandatory":true,
               "isVisibleAgent":true,
               "isVisibleCustomer":true,
               "isEditable":true,
               "custom_regexp":"",
               "value":"",
               "name":"email",
               "mode":"manual"
            },
            { 
               "_id":"5c6e700404445e26d8dbeee7",
               "dc_type":"phone",
               "label":"Phone number",
               "isMandatory":false,
               "isVisibleAgent":true,
               "isVisibleCustomer":true,
               "isEditable":true,
               "custom_regexp":"[0-9]{10}",
               "value":"",
               "name":"phone_number",
               "mode":"manual"
            },
            { 
               "_id":"5c6e700404445e26d8dbeee6",
               "dc_type":"date",
               "label":"Birthdate",
               "isMandatory":false,
               "isVisibleAgent":true,
               "isVisibleCustomer":true,
               "isEditable":true,
               "custom_regexp":"",
               "value":"",
               "name":"birthdate",
               "mode":"manual"
            }
         ],
         "_id":"5c6e700404445e26d8dbeee5",
         "id":"fc0450c8-4b2c-42b3-b8c9-04b672ca4a90",
         "title":"Anagrafica #2",
         "dc_mode":"chat",
         "next":"",
         "__v":0
      },
      "1c15e762-16ad-4f39-a677-b540f8894b21":{ 
         "datacollection":[ 
            { 
               "dc_type":"phone",
               "label":"Phone number",
               "isMandatory":true,
               "isVisibleAgent":true,
               "isVisibleCustomer":true,
               "isEditable":true,
               "custom_regexp":"[0-9]{10}",
               "value":"",
               "name":"phone_number",
               "mode":"manual"
            },
            { 
               "dc_type":"date",
               "label":"Birthdate",
               "isMandatory":false,
               "isVisibleAgent":true,
               "isVisibleCustomer":true,
               "isEditable":true,
               "custom_regexp":"",
               "value":"",
               "name":"birthdate",
               "mode":"manual"
            }
         ],
         "_id":"5d80aaf069277d76efd00023",
         "id":"1c15e762-16ad-4f39-a677-b540f8894b21",
         "title":"Callback Now",
         "dc_mode":"cbn",
         "next":"",
         "__v":0
      },
      "e991f35f-bf52-4fb5-ad73-36947cfd64a6":{ 
         "datacollection":[ 
            { 
               "dc_type":"name",
               "label":"Name",
               "isMandatory":false,
               "isVisibleAgent":true,
               "isVisibleCustomer":true,
               "isEditable":true,
               "custom_regexp":"",
               "value":"",
               "name":"name",
               "mode":"manual"
            },
            { 
               "dc_type":"surname",
               "label":"surname",
               "isMandatory":false,
               "isVisibleAgent":true,
               "isVisibleCustomer":true,
               "isEditable":true,
               "custom_regexp":"",
               "value":"",
               "name":"surname",
               "mode":"manual"
            }
         ],
         "_id":"5d822ed869277d76efd00024",
         "id":"e991f35f-bf52-4fb5-ad73-36947cfd64a6",
         "title":"Callback Now",
         "dc_mode":"cbn",
         "next":"",
         "__v":0
      }
   },
   "error":null
}
  • No labels