/check/multiple_order/o1

1.API Specification
2.Request Params
3.Response Params
4.Error Codes
5.Sample

1.API Specification

This API is used to check if someone is on the multiple order list by mobile number.

Request Method

POST

Request URL

https://cloudapi.accuauth.in/check/multiple_order/o1

Debugging Tool

Debugging Tool

2.Request Params

2.1 Request Header

Parameter Type Required Description
X-DF-API-ID string Yes For API credentials,Please visit API Request
X-DF-API-SECRET string Yes For API credentials,Please visit API Request

2.2 Request Body

Fields Type Description
required mobile_no string MD5 value of the mobile number with country code, example: md5(915586685366)
optional source string Data source, optional param, can be one of the value: seatvoicesms
optional date string Backtrack start time, format: YYYY-MM-DD, default is current date

3.Response Params

Fields Type Description
request_id string Unique id of each request
status string Response status, OK if request success, other if failed; See Error Codes for details
result object Check result,See result belowed for details
Elements in result:
Fields Type Description
target string Hit result, true: hit; false: not hit
count int Hit count
data object Hit records,See data belowed for details
Elements in data:
Fields Type Description
day string The date
source string Data source
cid string Customer ID
duration string Connection time to service agent, only return when data source is seat
level int level: 1: Whitelist; 2: Secondary Whitelist; 3: Normal customer; 4: Greylist; 5: Blacklist

Response Syntax
  • When target is hit
{
    "status": "OK",
    "result": {
        "target": true,
        "count": 2,
        "data": [
            {
                "day": "2022-10-03",
                "source": "seat",
                "cid": "11323",
                "duration": "17",
                "level": 5
            },
            {
                "day": "2022-10-03",
                "source": "seat",
                "cid": "11323",
                "duration": "11",
                "level": 5
            }
        ]
    },
    "request_id": "TIDebc4954bc59c4f9b8437c390d188442d"
}
  • When target is not hit
{
    "status": "OK",
    "result": {
        "target": false
    },
    "request_id": "TIDae6d0e0a9eb945c38964b77c1686707e"
}

4.Error Codes

Common error codes of this API:

Http Status Code Status field Description
400 INVALID_ARGUMENT Request parameter is invalid
401 UNAUTHORIZED Unauthorized or access is denied
401 KEY_EXPIRED Your API ID has expired
403 NO_PERMISSION You are not authorized to use this API
403 OUT_OF_QUOTA API calls quota exceeded
403 RATE_LIMIT_EXCEEDED API request frequency exceeds the limit
404 NOT_FOUND Requested API cannot be found
500 INTERNAL_ERROR Internal server error

Comment: Please see the reason field for details when the above 40X error occurred

Response Syntax
{
    "status": "INVALID_ARGUMENT",
    "reason": "argument 'mobile_no': not found",
    "request_id": "TID0bb59f6aa6454717b870b16202ccf36f"
}

5.Sample

results matching ""

    No results matching ""