Help Center/ Customer Engagement Center/ API Reference/ Case2.0 Interface Reference/ Interface of a Single UPS/ Handling a Case
Updated on 2025-03-31 GMT+08:00
View PDF
Share

Handling a Case

Description

This interface is used by a case owner or an administrator to handle a case. During case handling, internal records, emails, and instant messages can be sent.

Method

POST

URI

https://Domain name/service/AICC__Case/1.0.0/openapi/case/process (For example, the domain name is service.besclouds.com.)

Request Description

Table 1 Request header parameters

No.

Parameter

Type

Mandatory or Not

Description

1

Content-Type

String

Yes

Request body type, which is JSON

2

access-token

String

Yes

Token for a user to access a tenant space. For details, see 2.
Table 2 Request body parameters

No.

Parameter

Type

Length (Bytes)

Mandatory or Not

Description

1

caseId

String

20

Yes

Case ID

2

processInfo

ProcessInfo

-

Yes

Handling information. For details about the parameters of this object, see Table 3.

3

creatorId

String

20

Yes

Creator ID
Table 3 ProcessInfo parameters

No.

Parameter

Type

Length (Bytes)

Mandatory or Not

Description

1

type

String

-

Yes

Handling type

dataType: SingleSelect

Value range:

0. Iternal

1. Email

2. SMS

2

title

String

128

Yes

Title

3

description

String

20,000

Yes

Handling description

4

from

String

20

No

Sender ID

5

fromName

String

80

No

Sender name

6

toAddress

String

2000

No

Recipient's email address

7

creatorId

String

20

No

Handler ID

If the case type involved in the case handling is associated with a customized case template, extended fields in the case template can be added to the request body.

Response Description

  • Status code: 200

None

Example

Scenario: Handle a case.

URL: https://Domain name/service/AICC__Case/1.0.0/openapi/case/process

  • Request header
{
 "Content-Type": "application/json",
 "access-token": "0000000000************7bm63KsRmEztTvyA="
}
  • Request body 
    {
    "caseId": "c6m80000013ByxfHLVxo",
    "creatorId": "10gg000000sLj1ytR70C",
    "processInfo": {
        "type": "Iternal",
        "title": "123",
        "description": "456",
        "attachment": ""
    }
}
  • Response header
{ "connection": "keep-alive",
 "Content-Length": "16",
"Content-Type": "application/json%3Bcharset=UTF-8"}
  • Response parameters
{"resCode": "0","resMsg": "Success"}