Reference

This page provides additional information you need to configure and troubleshoot Conversational AI Engine RESTful APIs.

When calling the Conversational AI Engine RESTful API, you receive an HTTP status code.

• If the status code is 200, it means the request is successful.

• If the status code is not 200, the request failed. The response body contains statusCode and message fields, that describe the specific reason for the failure.

Following is a sample response:

_7

// HTTP status code is 400. Request parameter is abnormal.

_7

{

_7

"message": "create agent failed, code: 400, msg: properties: channel not found",

_7

"requestResponse": {},

_7

"statusCode": "InvalidRequest",

_7

"taskId": ""

_7

}

Response status code	Description	Suggested action
200	OK	The request was successful.
400	Invalid request parameters	Verify request parameters and correct any errors.
403	Unauthorized access	Contact technical support to activate the service.
404	Agent not found or has exited	Check whether the task has been started successfully or has stopped.
409	Agent Conflict	Use the taskId field to get the started agent_id, and use this ID for subsequent operations.
422	Access limit exceeded	Contact technical support.
502	Gateway error	Contact technical support.
503	Agent startup failure	Retry using a backoff strategy.
504	Request timeout	Retry using a backoff strategy.

The following table shows the possible statusCode values ​​and descriptions. Use the statusCode and message fields to troubleshoot the problem.

statusCode	Description
InternalError	Internal error on the server.
InvalidPermission	The service is not activated.
InvalidRequest	The request parameters are invalid.
ResourceQuotaLimitExceeded	Too many concurrent requests, exceeding the quota limit.
ServiceUnavailable	Internal error on the server.
TaskConflict	An Agent with the same name already exists.
TaskNotFound	The task was not started successfully, was aborted midway after starting, or has been destroyed.
TaskOperationTimeout	Internal error on the server.
NotImplemented	Internal error on the server.