Query Oa Quality

Verify Zalo Oa Quality via API

• URL：https://api.nxcloud.com/v1/zalo/oaQuality
• Method：POST
• Content-Type：application/json
• Authentication required：Yes

Authentication Mechanism

Please refer to the authentication rules at the specified address：The API interface invocation conventions(https://github.com/nxtele/http-api-document/wiki/API%E6%8E%A5%E5%8F%A3%E8%B0%83%E7%94%A8%E7%BA%A6%E5%AE%9A)

Parameters Header：

Parameter	Datatype	Mandatory	Example Value	Description
accessKey	String	yes	fme2na3kdi3ki	User identity identifier
ts	String	yes	1655710885431	The current timestamp of the request (units: milliseconds). The NXCLOUD server allows a maximum time deviation of 60 seconds for client requests
bizType	String	yes	9	The Zalo business type, set to a fixed value“9”
action	String	yes	mt	Send Zalo ZNS request，set to a fixed value“mt”
sign	String	yes	6e9506557d1f289501d333ee2c365826	The API input parameter signature，Signature algorithm

Receipt Parameters

• body parameters:

Parameter	Datatype	Mandatory	Example Value	Description
appkey	String	yes	pem28kje	Application appkey
journeyToken	String	yes	HmXFqeO5jM1Mw96Xu....	Journey Token

Receipt Examples

{
  "appkey": "O5XEr10d"
}

Example Respond

Successful Example

{
    "code": 0,
    "message": "Success",
    "data": {
        "oa7dayQuality": "HIGH",
        "oaCurrentQuality": "HIGH"
    }
}

Failure Example

{
    "code": -1,
    "message": "Failure",
    "traceId": "77f8709b545f4fee93fd7f098be9df04"
}

Status code description

Code	Message	Description
0	Success
-1	Failure	Please contact technical personnel to troubleshoot the issue.
9003	Customer APP does not exist / Status is unavailable	Application status is abnormal, contact business personnel to handle cloud platform application creation/disablement issues
9005	Missing customer APP routes	Supplier application does not exist
9010	Rate limit exceeded	Rate limit exceeded
17013	Zalo get oa quality error({0})	query oa quality exception