Contact data endpoints

Contact Center AI Platform (CCAI Platform) provides the CRM contact data endpoint for setting contact data.

CRM - contact_data

Parameter	Required	Data Type	Definition
lang	TRUE	String	Language code of the queue. (e.g. 'en')
menu_id	FALSE	Integer	Response will filter all menus in that menu's subtree, including that menu.
menu_type	FALSE	String	Returns menus of specific types. Possible values: ivr_menu, mobile_menu, web_menu).
channel_type	FALSE	String	Returns menus of a specific channel. Possible values: voice_call, chat).
wait[from]	FALSE	Integer	Returns records if they have a wait greater than the value.
wait[to]	FALSE	Integer	Returns records if they have a wait less than the value.

Endpoint:

 Method:  
POST
Type:  
RAW
URL:  
https:// { 
 { 
subdomain } 
 } 
. { 
 { 
domain } 
 } 
/apps/api/v1/crm/contact_data

Headers:

Key	Value	Description
Content-Type	application/json

Body:

  { 
  
 "call_id" 
  
 : 
  
 "1917" 
 , 
  
 "agent_id" 
  
 : 
  
 "1" 
 , 
  
  
 "lcm_key" 
  
 : 
  
 "2922|1|2|39|2|0|1" 
 , 
  
 "dnis" 
  
 : 
  
 "8001992999" 
 , 
  
 "org_id" 
  
 : 
  
 "tenant1" 
 , 
  
 "contact" 
  
 : 
  
 { 
  
 "first_name" 
  
 : 
  
 "Alex" 
 , 
  
 "last_name" 
  
 : 
  
 "Phil" 
 , 
  
 "account_no" 
  
 : 
  
 "10002-2989" 
 , 
  
 "crm_id" 
  
 : 
  
 "220-39307-92" 
 , 
  
 "address" 
  
 : 
  
 "" 
 , 
  
 "city" 
  
 : 
  
 "" 
 , 
  
 "loan_type" 
  
 : 
  
 "" 
 , 
  
 "due_date" 
  
 : 
  
 "" 
  
  
 }, 
  
 "pacing_mode" 
  
 : 
  
 "Predictive" 
 , 
  
 "call_type" 
  
 : 
  
 "OB_Regular" 
 }

Example request and responses

The following sections provide example requests to the endpoint.