This API retrieves detailed information about an agent in your CloudAgent account.
Rate Limit:
A maximum of 10 requests per minute is allowed.
To use this API with the help of a token, follow these steps:
- Generate the Token: Use the 'Generate Token' API to obtain an authentication token.
- Enter the Token ID: Navigate to the right section of this page, under the 'AUTHORIZATION' tab. Here, input the generated token ID.
- With the token entered, pass the below header and body parameters:
Header parameters
Parameter | Description |
---|---|
Content-Type | application/json |
Body Params
{
"userName": "xxxxxx",
"agentId": "xxxxxx"
}
Possible responses
Success response | { |
If userName is empty | "status": "error" |
If apiKey is empty | "status": "error" |
If userName or apiKey is invalid | "status": "error" |
If campaignName is invalid | "status": "error", |
If rate limit exceeds | "status": "error" |