v1

latestOpenAPI 3.0.02026-07-2449050.9 KB

default

Create Agent (Token Authentication)

Create a new agent in the system.

post/ca_apis/createAgent

Query parameters

detailedResponseboolean

Set this parameter to true to receive a detailed success response. Any other value will be ignored by the API.

Headers

Content-Typestring

Request body

userNamestring

CloudAgent account username

agentIdstring

Unique ID for the agent

agentNamestring

Full name of the agent

passwordstring

Password for agent login

emailstring email

Agent's email address

autoAnswerstring

Auto answer setting for the agent (e.g., All, None, Inbound, Outbound.)

sipLocationstring

SIP server location for the agent. Give the location name.

agentDatastring

Additional data for internal use.

agentGroupsstring

Comma-separated group names assigned to the agent

screenRecordingboolean

Enable or disable screen recording

inboundboolean

Enable inbound calling mode

manualboolean

Enable manual calling mode

previewboolean

Enable preview dialing mode

progressiveboolean

Enable progressive dialing mode

chatboolean

Enable chat mode

blendedboolean

Enables blended mode

blendedInboundboolean

Enable inbound calls in blended mode

blendedManualboolean

Enable manual dialing in blended mode

blendedPreviewboolean

Enable preview mode in blended setup

blendedProgressiveboolean

Enable progressive dialing in blended setup

blendedChatboolean

Enable chat in blended mode

Response

Successful response