Create Agent (Token Authentication)

post

https://{domainname}/ca_apis/createAgent

Create a new agent in the system.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

detailedResponse

boolean

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

Body Params

userName

string

CloudAgent account username

agentId

string

Unique ID for the agent

agentName

string

Full name of the agent

password

string

Password for agent login

string

Agent's email address

autoAnswer

string

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

sipLocation

string

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

agentData

string

Additional data for internal use.

agentGroups

string

Comma-separated group names assigned to the agent

screenRecording

boolean

Enable or disable screen recording

inbound

boolean

Enable inbound calling mode

manual

boolean

Enable manual calling mode

preview

boolean

Enable preview dialing mode

progressive

boolean

Enable progressive dialing mode

chat

boolean

Enable chat mode

blended

boolean

Enables blended mode

blendedInbound

boolean

Enable inbound calls in blended mode

blendedManual

boolean

Enable manual dialing in blended mode

blendedPreview

boolean

Enable preview mode in blended setup

blendedProgressive

boolean

Enable progressive dialing in blended setup

blendedChat

boolean

Enable chat in blended mode

callControls

object

Permissions for the agent on various call controls

skills

array of objects

List of skills assigned to the agent with priority levels

skills

Headers

Content-Type

string

Response

200

Successful response

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here!