Search API (Sync)

Search API Webhook makes it easy for agents in your operation to easily search for customer records in your CRM or Ticketing systems without the need to manage the customer record database in VCC Live. When this webhook is used and Search is allowed for agents in the Outbound settings, then the below-described operation will be performed when an agent performs a search on the interface.

For this functionality to work, in the project’s database you need to have an indexed field and you will need to provide that field’s name as uniqueId in the response body (see below customer_id). When the agent performs a search and the uniqueId provided in the response is already present in the VCC Live database, then that record can be selected by the agent. If the provided uniqueId is not present yet, then a record is created for it in the VCC Live database.

Note: If you set the request method to GET, Webhook parameters are sent in HTTP query parameters. In case of using POST, Webhook parameters are sent in an HTTP body.

Table of Contents

• Request Object
• Sample Request Body
• Sample Response Body

Request Object

Sample Request Body

{
    "fields": {
        "contact_name": "John Doe",
        "contact_phone": "",
        "contact_email": "john@[email protected]",
        "importid": 0,
        "numberid": 0,
        "name": ""
    },
    "limit": 10
}

Please note that:

• the customer’s phone number is always provided in field contact_phone
• it is recommended not to exceed the limit of 30

Sample Response Body

{
  "result": {
    "uniqueId": "customer_id",
    "customers": [
      {
        "customer_id": 1520000104548,
        "birth_date": "1966-01-09T00:00:00",
        "customertype_code": "DA",
        "contact_name": "John Doe",
        "contact_phone": "12344321",
        "gender": "MA",
        "maiden_name": "John Doe",
        "mothers_maiden_name": "Maria Doe",
        "town_of_birth": "London"
      },
      {
        "customer_id": 1520000170767,
        "birth_date": "1968-11-14T00:00:00",
        "customertype_code": "NB",
        "contact_name": "John Doe",
        "contact_phone": "43211234",
        "gender": "MA",
        "maiden_name": "Jim Doe",
        "mothers_maiden_name": "Alice Matthews",
        "town_of_birth": "Liverpool"
      }
    ]
  }
}