Help Center/ Customer Engagement Center/ API Reference/ System Configuration API Reference (API Fabric)/ SmartCare Interface/ Interface (submitquickdelimit) for Creating a SmartCare Quick Demarcation Task
Updated on 2025-11-13 GMT+08:00
View PDF
Share

Interface (submitquickdelimit) for Creating a SmartCare Quick Demarcation Task

Description

Create a SmartCare quick demarcation task.

Interface Method

POST

URI

https://Domain name/apiaccess/CC-Management/v1/smartcare/submitquickdelimit (for example, service.besclouds.com)

Request Description

Table 1 Parameters in the request header

No.

Parameter

Type

Mandatory

Description

1

X-APP-Key

string

True

App key, which is the user ID.

2

Authorization

string

True

Authentication field. The format is Bearer (space){Value of AccessToken returned by the tokenByAkSk interface}. (A space is required after Bearer.)
Table 2 Parameters in the request body

No.

Parameter

Type

Mandatory

Description

1

msisdn

String

True

Mobile number of a user.

2

startTime

String

True

Start time of quick demarcation in the tenant time zone.

Example: 1721283033000

Set this parameter to the time N earlier than the current time, where N is the value of the tenant parameter The time (h) pushed forward from the current time as start time when SmartCare delimits creation.

3

endTime

String

True

End time of quick demarcation in the tenant time zone.

Example: 1721283133000

Set this parameter to the current time, that is, the time when the task is created.

4

locale

String

True

Language.

  • The value zh_CN indicates Chinese.
  • The value en_US indicates English.
  • The value LOCAL indicates the local language.
NOTE:
  1. Only the preceding enumerated values (case-sensitive) can be entered. If other values are entered, the message "Incorrect query criteria" will be displayed.
  2. If LOCAL is entered, the returned data is preferentially displayed in the local language. If the local language is not configured, the returned data will be displayed in English.

5

scene

String

True

Scenario.

The scenario name specified by this parameter must be the same as the corresponding scenario name in Scenario Presetting. Otherwise, the demarcation cannot be performed.

6

longitude

String

False

Longitude.

The value ranges from –180 to 180. A maximum of six decimal places are allowed.

7

latitude

String

False

Latitude.

The value ranges from –90 to 90. A maximum of six decimal places are allowed.

8

radius

String

False

Radius.

The value is a non-negative integer, in meters.

Response Description

  • Status code: 200
    Table 3 Parameters in the response body

    No.

    Parameter

    Type

    Mandatory

    Description

    1

    returnCode

    String

    True

    Response code. The value 0 indicates success.

    2

    description

    String

    True

    Response description.

    3

    taskId

    String

    True

    ID of the created SmartCare quick demarcation task.
  • Status code: 400

    Incorrect request. Check the request path and parameters.

  • Status code: 401

    Unauthorized operation. 1. Check whether you have purchased related services. 2. Contact customer service to check the status of your account.

  • Status code: 404

    The requested content is not found. Check the request path.

  • Status code: 500

    Business failure. Check the values of parameters in the request.

Message Example

Request header:

x-app-key:9******************************3  
Authorization:Bearer e******************************e  
Content-Type:application/json

Request parameters:

{
    "msisdn": "6680512100869",
    "startTime": "1721283033000",
    "endTime": "1721283133000",
    "scene": "Voice",
    "locale": "en_US"
}

Response parameters:

{
    "returnCode": "0",
    "description": "Queried successfully. Data is available.",
    "taskId": "7532351aa3fb4fcc9eff66e6d5606f7f"
}
Parent topic: SmartCare Interface