Other

Ivr Data node configuration

● System API

Description：Query the unique customer details according to the customer number. The existence of the return param depends on whether it has been set in CRM. This API does not require a request header or request param, and is the default interface of the system. When setting this API in IVR, output param name should be consistent with the param name in the returned sample. API URL:
Request The method is as follows: GET

Request param (header):

Param	Type	Required	Description

Request param (query string)

Param	Type	Required	Description
tel	String	Yes	The param name must be set to tel, and the variable must be ivr_customer_number in the system variable

Return param

Param	Type	Required	Description
isVip	String	No	VIP or not 1.Yes
vipLevel	String	No	VIP level
userLabel	String	No	Customer tag
isblack	int	No	Blacklisted or not 1.Yes，0.No

Response example:

{
  
    "isVip": 1,  
    "vipLevel": "xxxxx",  
    "userLabel": "xxxx",  
    "isblack": 0
  
}

● Custom API FORM format

Description：The API used here is preferably a newly created API when creating a data request node in IVR. The header info, input param, and output param names can be customized, and the API return params need to be consistent with the output params (it is recommended to return all defined params to prevent the use of this return value in other nodes).

API URL: Custom API URL
Request The method is as follows: POST

Request param(header) :

Param	Type	Required	Description
Custom Header1	Custom type[int OR string]	Yes

Request param(query string):

Param	Type	Required	Description
Custom params1	Custom type[int OR string]	Yes

Request example：

curl https://xxxx.com/api/xxxx
-X POST
-H "Content-Type:application/x-www-form-urlencoded"  /Fixed format 
-H "Custom Header1:header 1" //Backend custom header param1
-H "Custom Header2:header 2" //Backend custom header param2
-D "partnerId=xxx&m&token=xxxx&source=0&robotNo=1&docId=xxxx&Custom params 1=Value 1&Custom params 2=Value 2

Return param:

Param	Type	Required	Description
Custom output param name 1	Custom type[int OR string]	Yes	Used for assigning values to variables
Custom output param name 2	Custom type[int OR string]	Yes	Used for assigning values to variables

Response example：

{
  
    "Custom output param name 1": "xxxxx",  
    "Custom output param name 2": "xxxxx"
  
}

● Custom API JSON format

Description：The API used here is preferably a newly created API when creating a data request node in IVR. The header info, input param, and output param names can be customized, and the API return params need to be consistent with the output params (it is recommended to return all defined params to prevent the use of this return value in other nodes).

API URL: Custom API JSON format
Request The method is as follows: POST

Request param(header) :

Param	Type	Required	Description
Custom Header	Custom type[int OR string]	Yes	Used for assigning values to variables

Request param(query string):

Param	Type	Required	Description
Custom params	Custom type[int OR string]	Yes	Used for assigning values to variables

Request example:

curl https://xxxx.com/api/xxxx
-X POST
-H "Content-Type: application/json" //Fixed format 
-H "Custom Header1:header Value1" //Backend custom header param 1
-H "Custom Header2:header Vaule2" //Backend custom header param 2
-d '{"Custom params 1":"xxxxxx","Custom params  2":"xxxxx"}'  

Return param:

Param	Type	Required	Description
Custom output param name 1	Custom type[int OR string]	Yes	Used for assigning values to variables
Custom output param name 2	Custom type[int OR string]	Yes	Used for assigning values to variables

Response example：

{
  
    "Custom output param name 1": "xxxxx",  
    "Custom output param name 2": "xxxxx"
  
}