Agent

Agent Login/Logout

post/CAServices/AgentAuthenticationV2/index.php

Request

  • Base URL
    https://in1-ccaas-api.ozonetel.com
  • URL
    https://in1-ccaas-api.ozonetel.com/CAServices/AgentAuthenticationV2/index.php
  • Auth
    HTTP basic

Request body application/x-www-form-urlencoded

userNamestring required

CloudAgent account name

modestring

Agent login mode (e.g., 'inbound', 'manual', 'preview', 'progressive', 'blended', 'chat'.)

statestring

Initial state of the agent after login

apiKeystring required

Available in CloudAgent admin login

phoneNumberstring required

Phone number used for login to which calls are routed. Not mandatory while logging out an agent.

actionstring required

Specify 'login' or 'logout'

Example request

{
  "userName": "XXXXXX",
  "mode": "manual",
  "state": "Ready",
  "apiKey": "KKXXXXXXX",
  "phoneNumber": "98xxxxx0",
  "action": "login"
}

Response

Successful authentication

Changes

No recorded changes to this operation across all 2 revisions of this API.