會員列表

用來取得所屬於某機器人的會員資料，並可依據參數，獲得特定之會員資料

Get client list

post

Retrieve a list of clients with pagination support

Authorizations

Query parameters

botIdstringRequired

The bot ID for the API request

customerIdstringOptional

Filter by customer ID

platformstring · enumOptional

Filter by platform

Possible values:

namestringOptional

Filter by client name

limitinteger · min: 1 · max: 100Optional

Maximum number of clients to return

Default: 10

offsetintegerOptional

Number of clients to skip

Default: 0

startAtintegerOptional

Start timestamp (1657867028700) for filtering clients

endAtintegerOptional

End timestamp (1657867028700) for filtering clients

nextstringOptional

Pagination token for next page

Body

secretstringRequired

Secret key for API authentication

Example: your_secret_key_here

Responses

200

Client list retrieved successfully

application/json

Responseall of

401

JWT token is invalid or expired

application/json

403

Permission denied - insufficient access rights

application/json

404

Resource not found

application/json

429

Rate limit exceeded

application/json

500

Internal server error

application/json

post

HTTPcURLJavaScriptPython

POST /api/openapi/clients HTTP/1.1
Host: mantago.cc
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "secret": "your_secret_key_here"
}

{
  "success": true,
  "message": "Operation completed successfully",
  "clientList": {
    "list": [
      {
        "clientId": "U1234567890abcdef",
        "clientName": "John Doe",
        "clientHeadshot": "https://example.com/avatar.jpg",
        "platform": "line",
        "remark": "VIP customer",
        "isBlock": false,
        "customerId": "cust_12345",
        "userName": "John Doe",
        "userEmail": "[email protected]",
        "userPhone": "[phone]",
        "userBirthday": "1990-01-01",
        "userAddress": "台北市信義區",
        "createdAt": "2023-07-15T10:30:28.700Z",
        "updatedAt": "2023-07-15T15:45:12.500Z",
        "lastInteractAt": "2023-07-15T14:20:33.800Z",
        "autoTags": [
          {
            "name": "VIP",
            "createdAt": "2023-07-15T10:30:28.700Z"
          }
        ],
        "tags": [
          {
            "name": "VIP",
            "createdAt": "2023-07-15T10:30:28.700Z"
          }
        ],
        "tourTags": [
          {
            "name": "VIP",
            "createdAt": "2023-07-15T10:30:28.700Z"
          }
        ],
        "personalTags": [
          {
            "name": "VIP",
            "createdAt": "2023-07-15T10:30:28.700Z"
          }
        ]
      }
    ],
    "next": "next_page_token"
  }
}