IDN SAAS saas_plat openapi customer_fields - nxtele/nxcloud-doc-en GitHub Wiki

Query Customer Fields

Query customer fields via API.

  • URL: https://api-idn.nxlink.ai/saas/cdp/openapi/customers/fields
  • Method: GET
  • Content-Type: application/json
  • Requires authentication: Yes

Request Parameters

Header Parameters

Parameter Type Required Example Description
accessKey String Yes fme2na3kdi3ki User identity key
ts String Yes 1655710885431 Timestamp in milliseconds. Max allowed time drift is 60 seconds.
bizType String Yes 2 WhatsApp business type, fixed value "2"
action String Yes mt WhatsApp action, fixed value "mt"
sign String Yes 6e9506557d1f289501d333ee2c365826 Signature, see common auth rules

Query Parameters

Parameter Type Required Example Description
tenant_id Long Yes 1 Tenant ID
appkey String Yes pem28kje Application appkey

Response Parameters

Parameter Type Description
code Integer Result code
data JsonObject Result data
message String Message
traceId String Trace ID

data object

Parameter Type Description
customFieldList array Custom fields list
systemFieldList array System fields list

Response Example

{
    "code": 0,
    "message": "",
    "data": {
        "customFieldList": [],
        "systemFieldList": []
    },
    "traceId": "xxxx"
}