Help Center/ Cognitive Engagement Center/ API Reference/ Chatbot Management Interface Reference/ Domain Query Interface
Updated on 2023-09-27 GMT+08:00
View PDF

Domain Query Interface

Description

The OIAP provides an interface for third-party systems to query activated domain information in the intelligent interaction system.

Interface Method

POST

URL

https://IP:PORT/oifde/rest/api/querydomaininfo

Request

Table 1 Parameter in the request header

No.

Parameter

Type

Mandatory

Description

1

Content-Type

String

Yes

The value is fixed to application/json; charset=UTF-8.
Table 2 Parameters in the request body

Parameter

Type

Position

Mandatory

Description

tenantId

String

Body

Yes

Tenant ID.

language

String

Body

No

Language. The options are as follows:

  • zh_CN: Chinese
  • en_US: English
  • es_ES: Spanish
  • ar: Arabic
  • fr_FR: French

If this parameter is left blank or set to "", domains in all languages are returned. If a language is specified, only domains in the specified language are returned.

authToken

String

Body

Yes

Authentication token.

For details, see C3 OIAP Interface Authentication.

Response

Parameter

Type

Position

Mandatory

Description

errorCode

Integer

Body

Yes

Error code.

  • 0 or null: success
  • Other values: failure

    The status code 200 also indicates success.

errorMsg

String

Body

No

Error description.

domains

domain[]

Body

Yes

Domain information, which is generated in array format.
Table 3 domain

Parameter

Type

Position

Mandatory

Description

tenantId

String

Body

Yes

Tenant ID.

domainId

Integer

Body

Yes

Domain ID.

domainName

String

Body

Yes

Domain name.

language

String

Body

Yes

Language. The options are as follows:

  • zh_CN: Chinese
  • en_US: English
  • es_ES: Spanish
  • ar: Arabic
  • fr_FR: French

If this parameter does not exist, domains in all languages are returned. If this parameter exists, only domains in the specified language are returned.

Example

  • Request
{
    "tenantId":"202104237142",
    "language":"en_US",
    "authToken":"w***************************"
}
  • Response
{
    "errorCode" : 0, // Error code, which is an integer. If no error is reported, the value is 0.
    "errorMsg" : "", // Error message, which is a string. If no error is reported, this parameter is left blank.
    "domains" : [{  // Domain list, which is an object array.
        "tenantId":"tenant0001", // Tenant ID, which is a string.
        "domainId": 10079, // Domain ID, which is an integer.
        "domainName":"Shanxi flow" // Domain name, which is a string.
        "language" : "en_US"// Language, which is a string. (Currently, zh_CN, en_US, es_ES, and ar are supported.)
    }, {
        ……
    }]
}