Udesk-Customer service solution leader

Initialize Session

Request URL

POST /v1/initClient

Request Parameters

Request Fields

Path	Type	Optional	Description
robotId	Integer	false	Robot ID, the identifier of the current session's robot.
channelId	Integer	false	Channel ID, the identifier of the current session's channel.
modelKey	String	true	FAQ template ID, viewable in 'KM - Robot - Knowledge Base Management - Recommendation - ID'.
accessKeyId	String	true	Application ID of the integration settings, corresponding to the appID field obtained in 'KM - Management - Application Management - App ID'.
platform	Integer	true	Channel: 0: Web, 1: Normal WeChat, 2: Android, 3: iOS, 4: Weibo, 5: Customer Service System API, 6: Multi-merchant, 7: WeChat Mini Program, 8: Enterprise WeChat.
customer	Map	true	Customer information.
shortcutCustomId	String	true	Custom ID for shortcut entry.

Structure of `customer`

{
	"id": "Customer ID",
	"nickname": "Customer Name",
	"ip": "Customer IP",
	"province": "Province of IP",
	"city": "City of IP",
	"orgName": "Company Name",
	"email": "Customer Email",
	"phone": "Customer Phone",
	"tags": "Customer Tags",
	"desc": "Description",
	"level": "Customer Level",
	"platform": "Channel",
	"src": "Source",
	"srcUrl": "Source URL",
	"webPluginName": "Source Plugin",
	"keyword": "Search Keyword",
	"generatedChannel": "Custom Channel Information",
	"loginUrl": "Access Landing Page",
	"sessionUrl": "Conversation Start Page",
	"weChatOpenId": "WeChat OPENID",
	"c_cf_dialogueDesc": "Dialogue Description (Usage: Refer to the webhook task push-type interface)"
}

Response

Path	Type	Description
code	Integer	Status code
message	String	Return message
visible	Boolean
data	Object	Return data

`data`

Path	Type	Description
sessionId	Integer	Session ID
logId	Integer	ID returned by the robot
welcomeMessage	String	Welcome message
leadingWord	String	Leading word
commonQuestionModel	Object	Common question model

`commonQuestionModel`

Path	Type	Description
id	Integer	ID
name	String	Model name
channelId	Integer	Channel ID
description	String	Description
modelKey	String	FAQ template ID
commonQuestionCategoryList	Array	List of common question categories
shortcutEntryList	Array	List of shortcut entries

`commonQuestionCategoryList`

Path	Type	Description
id	Integer	Category ID
modelId	Integer	Common question model ID
name	String	Directory name
sorts	Integer	Reserved sorting field
questionList	Array	List of common questions under the category

`questionList`

Path	Type	Description
id	Integer	ID of the question
content	String	Content of the question
type	Integer	Type: 1 - Normal question, 4 - Chat question
answer	Object	Answer
answer.content	String	Answer content
answer.type	Integer	Answer type
answer.id	Integer	Answer ID

`shortcutEntryList`

Path	Type	Description
modelId	Integer	ID of the shortcut entry
type	Integer	Type: 1 - Text, 2 - Link
name	String	Entry name
content	String	Content
pic	String	Image URL
sorts	Integer	Reserved sorting field
isDefault	Integer	Whether it is default

Example

$ curl 'https://km.udesk.cn/api/v1/initClient?email=admin@udesk.cn&timestamp=1529402445&sign=fbe02e2b9f76179da49ea619cbabdde909b73a2f' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
  "robotId" : 103,
  "channelId" : 106,
  "modelKey" : "

0",
  "accessKeyId" : "/+7772AKE6kv8AVNjWqP",
  "platform" : 5,
  "customer" : null
}'

Response

{
    "code": 200,
    "message": "OK",
    "visible": false,
    "exception": null,
    "paging": null,
    "data": {
        "sessionId": 451724,
        "logId": 793020,
        "welcomeMessage": "Hello ，I'm glad to serve you.！",
        "leadingWord": "Frequently Asked Questions (FAQs)",
        "commonQuestionList": [],
        "commonQuestionModel": {
            "id": 108,
            "name": "Default frequently asked questions",
            "description": "Common questions",
            "commonQuestionCategoryList": [
                {
                    "id": 76,
                    "modelId": 108,
                    "name": "111",
                    "questionList": [
                        {
                            "id": 8645,
                            "content": "How to handle social security, what are the main guiding options?",
                            "type": 1,
                            "answer": {
                                "content": "<p>Make a phone call 12345</p>",
                                "type": 2,
                                "id": 4436
                            }
                        },
                        {
                            "id": 8647,
                            "content": "How to handle social security",
                            "type": 1,
                            "answer": {
                                "content": "<p>Online inquiry</p>",
                                "type": 2,
                                "id": 4437
                            }
                        }
                    ]
                }
            ]
        }
    }
}

Click Flow Interface

Request URL

POST /v1/flow

Request Parameters

Request Fields

Path	Type	Optional	Description
sessionId	Integer	false	Session ID, the identifier of the current session, obtained when initializing the session (/api/initClient).
logId	Integer	true	Identifier of the log where the flow click is located, provided by the robot when returning.
flowId	Integer	true	Flow identifier, provided in the flow content (flowContent) returned by the robot.
flowContent	String	true	Specific flow content.

Response

Path	Type	Description
code	Integer	Status code
message	String	Return message
data	Object	Session information

`data`

Path	Type	Description
sessionId	Integer	Session ID
logId	Integer	ID returned by the robot
flowId	Integer	Flow ID, valid when returning the flow
flowTitle	String	Flow title, valid when returning the flow
flowContent	String	Flow content, valid when returning the flow
restrictionState	Object	Interaction limit state
restrictionState.exceededFlag	Integer	Exceeding limit flag [0: normal / 1: exceeded]
restrictionState.usedCount	Integer	Number of used interactions
restrictionState.totalCount	Integer	Total limit count

Example

$ curl 'https://km.udesk.cn/api/v1/flow?email=admin@udesk.cn&timestamp=1529402444&sign=17dfc106671e1cd2442ba6e61c778aac86bb3035' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
  "sessionId" : 450285,
  "logId" : 785709,
  "flowId" : 42,
  "flowContent" : "<p>11111</p><p>22222</p><p>33333</p>"
}'

Response

{
    "code": 200,
    "message": "OK",
    "visible": false,
    "data": {
        "sessionId": 28905,
        "logId": 793020,
        "flowId": 285,
        "flowTitle": "Process issue",
        "flowContent": "<p>1111</p>",
        "suggestQuestionList": [],
        "restrictionState": {
            "exceededFlag": 0,
            "usedCount": 32,
            "totalCount": 1000000
        }
    }
}

Failure Reasons

{
  "code": 400,
  "message": "{specific exception information}",
  "visible": false
}

message	description
"sessionId does not exist! Please reinitialize"	The conversation corresponding to sessionId does not exist
"【...】javax.validation.constraints.NotNull.message"	The specific field cannot be empty
"The system could not find the process"	The process corresponding to flowId does not exist

Click Question Behavior Interface

Request URL

POST /v1/hit

Request Parameters

Request Fields

Path	Type	Optional	Description
sessionId	Integer	false	Identifier of the current session.
queryType	Integer	true	User click type enumeration. Possible values: 6, 7, 8, 9.
logId	Integer	true	Identifier of the log where the user click behavior is located.
questionId	Integer	true	ID of the clicked question.
questionContent	String	true	Content of the clicked question.
contentType	String	true	Enumeration: text, rich. If it is text, the ansContent will be converted from rich text to plain text.
hitSource	Integer	true	1. Message from shortcut entry, 2. Click on button text, 3. Structured message from product list.

Response

Path	Type	Description
code	Integer	Result code
message	String	Result description
data	Object	Session information

`data`

Path	Type	Description
sessionId	Integer	Session ID
logId	Integer	ID returned by the robot
ansContent	Var	Content of the corresponding answer
ansType	Integer	Answer type
attachmentList	Array	List of question attachments
attachmentList[].name	String	Name of the question attachment
attachmentList[].address	String	Link of the question attachment
attachmentList[].size	Integer	Size of the question attachment
flowId	Integer	Flow ID, valid when returning the flow
flowTitle	String	Flow title, valid when returning the flow
flowContent	String	Flow content, valid when returning the flow
hitQuestion	String	Question recalled
msgType	String	Answer type
switchStaffType	Integer	1. Recommended switch to human, 2. Switch to human if conditions are met, 3. Send message
switchStaffAnswer	String	Message for switching to human
suggestQuestionList	Array	List of suggested questions
suggestQuestionList[].id	Integer	ID of the suggested question
suggestQuestionList[].content	String	Content of the suggested question
suggestQuestionList[].type	Integer	Type of the suggested question
suggestQuestionList[].answer	Object	Answer of the suggested question
suggestQuestionList[].answer.content	String	Content of the suggested question's answer
suggestQuestionList[].answer.type	Integer	Type of the suggested question's answer
suggestQuestionList[].answer.id	Integer	ID of the suggested question's answer
aid	Integer	ID of the corresponding answer, valid when returning the answer

Example

$ curl 'https://km.udesk.cn/api/v1/hit?email=admin@udesk.cn&timestamp=1529402439&sign=2c8f96911159fae72a493365a9692ce66c5c2b5d' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
  "sessionId" : 450283,
  "queryType" : 7,
  "logId" : 785703,
  "questionId" : 232,
  "questionContent" : "Whose fan?"
}'

Response

{
    "code": 200,
    "message": "OK",
    "visible": false,
    "exception": null,
    "paging": null,
    "data": {
        "sessionId": 451727,
        "logId": 793031,
        "ansContent": "<p>Unpeaceful</p>\n<p><audio style=\"display: none;\" controls=\"controls\"></audio></p>\n<p><audio style=\"display: none;\" controls=\"controls\"></audio></p>",
        "attachmentList": [],
        "suggestQuestionList": [
            {
                "id": 8657,
                "content": "Where in the world is peaceful?",
                "type": 1,
                "answer": {
                    "content": "<p>No</p>\n<p><audio style=\"display: none;\" controls=\"controls\"></audio></p>",
                    "type": 2,
                    "id": 4442,
                    "deleteFlag": 0
                }
            },
            {
                "id": 9259,
                "content": "Where do you want to go?",
                "type": 1,
                "answer": {
                    "content": "<p>New York</p>\n<p><audio style=\"display: none;\" controls=\"controls\"></audio></p>",
                    "type": 2,
                    "id": 5009,
                    "deleteFlag": 0
                }
            }
        ],
        "aid": 4441
    }
}

Failure Reasons

{
  "code": 400,
  "message": "{specific exception information}",
  "visible": false
}

message	description
"sessionId does not exist! Please reinitialize"	The conversation corresponding to sessionId does not exist
"【...】javax.validation.constraints.NotNull.message"	The specific field cannot be empty

Get Session Window - Frequently Asked Questions List

Request URL

POST /v1/chat/commonQuestions

Request Parameters

Request Fields

Path	Type	Optional	Description
robotId	Integer	false	Robot ID
channelId	Integer	false	Scene ID
modelKey	String	false	Common problem template ID, view in 'km-robot-knowledge base management-common questions-ID'

Response

Path	Type	Description
code	Integer	Result code
message	String	Result description
data	Array	List of common questions information
data[].id	Integer	Category ID of the common questions list
data[].modelId	Integer	Template ID of the common questions list
data[].name	String	Category name of the common questions list
data[].questionList	Array	Common questions under the category
data[].questionList[].id	Integer	Question ID
data[].questionList[].content	String	Question content
data[].questionList[].type	Integer	Type 1: normal question, 4: chit-chat question, 5: message
data[].questionList[].answer	Object	Answer
data[].questionList[].answer.content	String	Answer content
data[].questionList[].answer.type	Integer	Answer type
data[].questionList[].answer.id	Integer	Answer ID

Example

$ curl 'https://km.udesk.cn/api/v1/chat/commonQuestions?email=admin@udesk.cn&timestamp=1529569037&sign=4bc33f53e473d6db70e900fb07b947a9ee18f905' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
  "robotId" : 112,
  "channelId" : 118,
  "modelKey" : "aaa"
}'

Response

{
    "code": 200,
    "message": "OK",
    "visible": false,
    "exception": null,
    "paging": {
        "pageNum": 1,
        "pageSize": 1,
        "total": 1
    },
    "data": [
        {
            "id": 76,
            "modelId": 108,
            "name": "111",
            "questionList": [
                {
                    "id": 8645,
                    "content": "How to choose the main guidance for handling social security?",
                    "type": 1,
                    "answer": {
                        "content": "<p>make call 12345</p>",
                        "type": 2,
                        "id": 4436
                    }
                },
                {
                    "id": 8647,
                    "content": "How to handle social security",
                    "type": 1,
                    "answer": {
                        "content": "<p>Online inquiry</p>",
                        "type": 2,
                        "id": 4437
                    }
                }
            ]
        }
    ]
}

Get Session Window - Hot Questions List

Request URL

POST /v1/chat/hotQuestions

Request Parameters

Request Fields

Path	Type	Optional	Description
limitDayNum	Integer	false	Number of days (no more than 100)
limitResultNum	Integer	false	Maximum number of records returned (no more than 50)
robotId	Integer	false	Robot ID

Response

Path	Type	Description
code	Integer	Result code
message	String	Result description
data	Array	List of questions
data[].id	Integer	Question ID
data[].content	String	Question content
data[].type	Integer	Question type
data[].answer	Object	Answer
data[].answer.content	String	Answer content
data[].answer.type	Integer	Answer type
data[].answer.id	Integer	Answer ID
data[].matchCount	Integer	Matching count

Example

$ curl 'https://km.udesk.cn/api/v1/chat/hotQuestions?email=admin@udesk.cn&timestamp=1529569036&sign=27bfe3f1ece19e13b03ff669d30830322ae4cfa3' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
  "limitDayNum" : 100,
  "limitResultNum" : 2,
  "robotId" : 83
}'

Response

{
    "code": 200,
    "message": "OK",
    "visible": false,
    "exception": null,
    "paging": {
        "pageNum": 1,
        "pageSize": 2,
        "total": 2
    },
    "data": [
        {
            "id": 844,
            "content": "Who are you？",
            "type": 1,
            "answer": {
                "content": "I'm robot",
                "type": 2,
                "id": 552
            },
            "matchCount": 24
        },
        {
            "id": 9426,
            "content": "example content",
            "type": 3,
            "answer": {
                "content": "123",
                "type": 1,
                "id": 5124
            },
            "matchCount": 13
        }
    ]
}

Evaluate Robot's Answer

Request URL

POST /v1/surveyQuestion

Request Parameters

Request Fields

Path	Type	Optional	Description
sessionId	Integer	false	Session ID
questionSurveyOptionId	Integer	false	Evaluation option: 1 for satisfied, 2 for unsatisfied
logId	Integer	true	ID of the record where the answer to be evaluated is located, obtained from the robot's response

Response

Path	Type	Description
code	Integer	Execution status code
message	String	Execution result explanation

Example

$ curl 'https://km.udesk.cn/api/v1/surveyQuestion?email=admin%40udesk.cn&timestamp=1529402453&sign=de8f53541749eb530fc006941d6af1af4e917067' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
  "sessionId" : 450289,
  "questionSurveyOptionId" : 1,
  "logId" : 785716
}'

Response

{
  "code" : 200,
  "message" : "OK",
  "visible" : false
}

Possible Failure Reasons

{
  "code": 400,
  "message": "{specific error message}",
  "visible": false
}

message	description
This reply has been evaluated!	The conversation has already been evaluated
The relationship between sessionId and sessionLogId does not exist!	logId does not belong to the corresponding sessionId
sessionId does not exist! Please reinitialize	The conversation corresponding to sessionId does not exist
javax.validation.constraints.NotNull.message	{specific field} cannot be null

Evaluate Robot Session

Request URL

POST /v1/surveySession

Request Parameters

Request Fields

Path	Type	Optional	Description
sessionId	Integer	false	Session ID
sessionSurveyOptionId	Integer	true	Evaluation option: 1 for not evaluated, 2 for satisfied, 3 for neutral, 4 for unsatisfied
surveyContent	String	true	Evaluation content

Response

Path	Type	Description
code	Integer	Execution status code
message	String	Execution result information
data	Object	Returned content
data.switchStaffType	Integer	1. Display guide language for WeChat channel, 2. Switch to human when conditions are met
data.switchStaffTips	String	Tip for switching to human

Example

$ curl 'https://km.udesk.cn/api/v1/surveySession?email=admin@udesk.cn&timestamp=1529402455&sign=d4be213127c62bb5b53dea5f5e52eaad06b2362f' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
  "sessionId" : 450290,
  "sessionSurveyOptionId" : 4,
  "surveyContent" : "hehe"
}'

Response

{
  "code" : 200,
  "message" : "OK",
  "visible" : false
}

General Conversation

Request URL

POST /v1/chat

Request Parameters

Request Fields

Path	Type	Optional	Description
sessionId	Integer	false	Session ID: obtained during session initialization (/api/initClient)
robotId	Integer	false	Robot ID: identification ID for this session's robot
queryContent	String	false	User query content
channel_id	Integer	true	Knowledge base scene ID
weixin_openid	String	true	WeChat openid
contentType	String	true	Text type: If the value is "text", ansContent will be converted from rich text to plain text
chatMode	Integer	true	Chat mode: 1 for intelligent mode, 2 for task-based conversation, 3 for FAQ, 4 for knowledge base

Response

Path	Type	Description
code	Integer	Execution status code
message	String	Execution result explanation
data	Object	Conversation information
data.sessionId	Integer	Session ID
data.logId	Integer	Log ID returned by the robot
data.enableAppraise	Boolean	Whether the conversation allows evaluation
data.ansContent	String	Content of the corresponding answer
data.ansType	Integer	Answer type
data.msgType	String	Text type of the answer
data.switchStaffType	Integer	1. Recommend switch to human, 2. Switch to human when conditions are met, 3. Send message
data.switchStaffAnswer	String	Message for switching to human
data.suggestQuestionList	Array	Suggested question list

Example

$ curl 'https://km.udesk.cn/api/v1/chat?email=admin@udesk.cn&timestamp=1529402441&sign=08bea0badd00d36c432320fc3760fc419154b40d' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
  "sessionId" : 451714,
  "robotId" : 54,
  "queryContent" : "Mobile phone price",
  "contentType" : null,
  "chatMode" : null,
  "channel_id" : null,
  "weixin_openid" : null
}'

Response

{
  "code" : 200,
  "message" : "OK",
  "visible" : false,
  "data" : {
    "sessionId" : 451714,
    "logId" : 793005,
    "ansContent" : "Your questions inspire me to keep learning and improving. I look forward to providing you with better service next time.",
    "ansType" : 6,
    "msgType" : "plain",
    "suggestQuestionList" : [ ]
  }
}

Possible Failure Reasons

{
  "code": 400,
  "message": "{specific error message}",
  "visible": false
}

message	description
sessionId does not exist! Please reinitialize	The conversation corresponding to sessionId does not exist
Question content cannot be empty	queryContent cannot be empty

Different Examples for data.ansType

ansType indicates the hit business type, which has no direct relationship with the message content

Value	Description
1	Return answer
2	Deprecated
3	Return suggestion list
4	Return greeting
5	Deprecated
6	Return unknown
7	Click-type message
8	Sensitive word
9	Message-triggered webhook
10	Knowledge graph node
11	Task-based dialogue
12	Database dialogue
13	Silent
14	Database full attribute response
15	Knowledge graph
16	Reading comprehension answer
17	Reading comprehension suggestion
18	Reading comprehension guide selection
19	Special message
20	Database Q&A
21	Transfer to human intent
22	New task-based dialogue button
23	New version task-based dialogue
24	Active solicitation
25	Enterprise search

Intelligent Assistant

Request Endpoint

POST /v1/assist

Request Parameters

Request fields

Path	Type	Optional	Description
robotId	Integer	false	Robot ID.
channelId	Integer	false	Channel ID.
queryContent	String	true	Content of the query.

Response Result

Path	Type	Description
code	Integer	Execution result code.
message	String	Execution result description.
data	Object	Session information.
data.sessionId	Integer	Session ID.
data.logId	Integer	Identifier ID for the robot's log.
data.ansContent	String	Content of the corresponding answer returned.
data.ansType	Integer	Answer type.
data.flowId	Integer	Flow ID, valid when returning a flow.
data.flowTitle	String	Flow title, valid when returning a flow.
data.flowContent	String	Flow content, valid when returning a flow.
data.hitQuestion	String	Recalled question.
data.msgType	String	Text type of the answer.
data.switchStaffType	Integer	1. Display guide language on WeChat channel 2. Switch to manual when conditions are met.
data.switchStaffTips	String	Switch to manual prompt.
data.suggestQuestionList	Array	List of suggested questions.
data.suggestQuestionList[].id	Integer	Identifier ID of the suggested question.
data.suggestQuestionList[].content	String	Content of the suggested question.
data.suggestQuestionList[].type	Integer	Type of suggested question.
data.suggestQuestionList[].answer	Object	Answer to the suggested question.
data.suggestQuestionList[].answer.content	String	Content of the suggested question's answer.
data.suggestQuestionList[].answer.type	Integer	Type of the suggested question's answer.
data.suggestQuestionList[].answer.questionId	Integer	Question ID corresponding to the answer to the suggested question.
data.suggestQuestionList[].answer.id	Integer	Answer ID of the suggested question.
data.restrictionState	Object	Interaction limit state.
data.restrictionState.exceededFlag	Integer	Exceeding limit flag [0 normal/1 exceeded].
data.restrictionState.usedCount	Integer	Number of times used.
data.restrictionState.totalCount	Integer	Total limit.
data.aid	Integer	ID of the corresponding answer returned, effective when the question is a FAQ question.

Example

$ curl 'https://km.udesk.cn/api/v1/assist?email=admin@udesk.cn&timestamp=1529402447&sign=c3168ff8ee9db4208d3a6f8a49d4bea7d4058ab3' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
  "robotId" : 83,
  "channelId" : 83,
  "queryContent" : "Hello"
}'

Response

{
  "code" : 200,
  "message" : "OK",
  "visible" : false,
  "data" : {
    "ansContent" : "I am the robot.",
    "attachmentList" : [ ],
    "hitQuestion" : "Who are you?",
    "msgType" : "rich",
    "suggestQuestionList" : [ ],
    "aid" : 552
  }
}

Smart Hint API

Request Endpoint

POST /v1/smartHint

Request Parameters

Request fields

Path	Type	Optional	Description
sessionId	Integer	false	Session ID.
keyword	String	true	Keyword.

Response Result

Path	Type	Optional	Description
code	Integer	true	Status code.
message	String	true	Return message.
visible	Boolean	true
data	Object	true	Returned content.
data.smartTipList	Array	true	List of smart hint questions.
data.smartTipList[].id	Integer	true	Identifier ID of the question.
data.smartTipList[].content	String	true	Content of the question.
data.smartTipList[].type	Integer	true	Question type.
data.smartTipList[].answer	Object	true	Answer.
data.smartTipList[].answer.content	String	true	Answer content.
data.smartTipList[].answer.type	Integer	true	Answer type.
data.smartTipList[].answer.questionId	Integer	true	Question ID corresponding to the answer.
data.smartTipList[].answer.id	Integer	true	Answer ID.

Example

$ curl 'https://km.udesk.cn/api/v1/smartHint?email=admin@udesk.cn&timestamp=1529402446&sign=a685c1c3881aebe59c79306ef6d288c25fab077b' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
  "sessionId" : 450287,
  "keyword" : "social security"
}'

Response

{
    "code": 200,
    "message": "OK",
    "visible": false,
    "exception": null,
    "paging": null,
    "data": {
        "smartTipList": [
            {
                "id": 8645,
                "content": "How to handle social security",
                "type": 1,
                "answer": {
                    "content": "<p>Call 12345</p>",
                    "type": 2,
                    "id": 4436
                }
            }
        ]
    }
}

Reasons for Request Failure

{
  "code": 400,
  "message": "{Specific exception information}",
  "visible": false
}

message	description
The robot does not exist or has been deleted!	The robot corresponding to the robotid does not exist.
The scene does not exist	The scene corresponding to the channelId does not exist.
【...】javax.validation.constraints.NotNull.message	【Specific field】cannot be empty.

Switch to Manual Notification API

Request Endpoint

PUT /v1/sessions/:id/switchStaff

Request Parameters

Path parameters

Parameter	Type	Optional	Description
id	Integer	false	Session ID of this session.

Response Result

Path	Type	Description
code	Integer	Execution status code.
message	String	Execution result message.

Example

$ curl 'https://km.udesk.cn/api/v1/sessions/451718/switchStaff?email=admin@udesk.cn&timestamp=1529402455&sign=d4be213127c62bb5b53dea5f5e52eaad06b2362f' -i -X PUT -H 'Accept: application/json'

Response

{
  "code" : 200,
  "message" : "OK",
  "visible" : false
}

Initialize Session

Request URL

Request Parameters

Request Fields

Structure of customer

Response

data

commonQuestionModel

commonQuestionCategoryList

questionList

shortcutEntryList

Example

Response

Click Flow Interface

Request URL

Request Parameters

Request Fields

Response

data

Example

Response

Failure Reasons

Click Question Behavior Interface

Request URL

Request Parameters

Request Fields

Response

data

Example

Response

Failure Reasons

Get Session Window - Frequently Asked Questions List

Request URL

Request Parameters

Request Fields

Response

Example

Response

Get Session Window - Hot Questions List

Request URL

Request Parameters

Request Fields

Response

Example

Response

Evaluate Robot's Answer

Request URL

Request Parameters

Request Fields

Response

Example

Response

Possible Failure Reasons

Evaluate Robot Session

Request URL

Request Parameters

Request Fields

Response

Example

Response

General Conversation

Request URL

Request Parameters

Request Fields

Response

Example

Response

Possible Failure Reasons

Different Examples for data.ansType

Intelligent Assistant

Request Endpoint

Request Parameters

Request fields

Response Result

Example

Response

Smart Hint API

Request Endpoint

Request Parameters

Request fields

Structure of `customer`

`data`

`commonQuestionModel`

`commonQuestionCategoryList`

`questionList`

`shortcutEntryList`

`data`

`data`