Agents

HTTP	Resource	Description
GET	agents	Returns a list of agents.
GET	agents/:login	Returns agent info.
GET	agents/:login/last_queue_call	Returns the last queue call.
GET	agents/:login/status	Returns the agent status.
GET	agents_groups	Returns agent groups.
GET	agents_statuses	Returns agent statuses.
GET	agents_work_report	Returns agent work report.
POST	agents	Creates a new agent.
POST	agents/:login/answer	Answer agent's phone when he uses Thulium Softphone.
POST	agents/:login/call	Makes a call for agent to the specified phone number.
POST	agents/:login/call_preview	Make call in preview outbound.
POST	agents/:login/free	Unpauses agent.
POST	agents/:login/hangup	Hangs up agent call.
POST	agents/:login/login	Logs in the specified agent.
POST	agents/:login/logout	Logs out the specified agent.
POST	agents/:login/pause	Pauses agent.
POST	agents/:login/stop_recording	Stops recording of the ongoing call for the specified agent.

Chats

HTTP	Resource	Description
DELETE	chat_conversations/:id	Removes the specified chat conversation.
GET	chats	Returns list of chats.
GET	chats/queues	Returns list of chats queues.
GET	chats/reports/summary	Returns chats report.
POST	chat_conversations/:id/message	Sends a chat message.
POST	chat_conversations/:id/stop	Finishes chat conversation.
POST	chat_conversations/start	Starts a chat conversation.

CRM

HTTP	Resource	Description
DELETE	companies/:id	Removes the specified company.
DELETE	customers/:id	Removes the specified customer.
GET	companies	Returns a collection of companies matching a specified query.
GET	companies/:id	Returns a single company, specified by an id parameter.
GET	customer_id_by_outbound_status	Returns a collection of identifiers of customers matching specified campaign statuses.
GET	customers	Returns a collection of customers matching a specified query.
GET	customers/:id	Returns a single customer, specified by an id parameter.
POST	companies	Creates a new company in CRM.
POST	customers	Creates a new customer in CRM.
POST	customers/:id/feed_records	Adds entry to customer feeds.
PUT	companies/:id	Updates a company in CRM.
PUT	customers/:id	Updates a customer in CC CRM.

CRM (batch)

HTTP	Resource	Description
DELETE	batch/customers	Removes many customers.
POST	batch/customers	Creates many customers.
PUT	batch/customers	Update many customers in CRM.

Outbounds

HTTP	Resource	Description
DELETE	outbounds/:id	Deletes the specified outbound with all its records.
GET	outbounds	Returns list of outbounds.
GET	outbounds/:id/agents	Returns list of all agents from a given outbound.
GET	outbounds/:id/stats	Returns records stats for outbound.
GET	outbounds/:id/statuses	Returns list of all statuses in a given outbound.
GET	outbounds/stats	Returns records stats for all active outbound.
POST	outbounds	Adds outbound.
POST	outbounds/:id/add_agents	Adds list of agents to outbound.
POST	outbounds/:id/clone	Clones outbound.
POST	outbounds/:id/remove_agents	Removes agents from outbound.
POST	outbounds/:id/set_agents	Adds and removes agents to and from outbound.
PUT	outbounds/:id	Update outbound.

Outbounds (batch)

HTTP	Resource	Description
DELETE	batch/outbounds	Deletes multiple outbounds with all its records.

CRM outbounds

HTTP	Resource	Description
DELETE	crm_outbounds/:id/records/:customer_id	Deletes the specified record from the CRM Outbound.
GET	crm_outbounds/:id/records	Returns a list of outbound records with primary parameters.
GET	crm_outbounds/:id/records/:customer_id	Returns CRM outbound record data.
POST	crm_outbounds/:id/records	Adds a new record to the specified CRM outbound.
POST	crm_outbounds/:id/records/:customer_id/copy_notes	Copy notes from outbound to CRM.
PUT	crm_outbounds/:id/records/:customer_id	Updates the specified record in the CRM outbound.

CRM outbounds (batch)

HTTP	Resource	Description
DELETE	batch/crm_outbounds/:id/records	Deletes many records from the CRM outbound.
POST	batch/crm_outbounds/:id/records	Adds many records to the specified CRM outbound.

CSV outbounds

HTTP	Resource	Description
DELETE	outbounds/:id/records/:phone_number	Deletes record from outbound.
DELETE	outbounds/:id/records_by_identifier/:identifier	Deletes record from outbound.
GET	outbounds/:id/records	Returns a list of outbound records with primary parameters.
GET	outbounds/:id/records/:phone_number	Returns outbound record data.
GET	outbounds/:id/records_by_identifier/:identifier	Returns outbound record data.
GET	outbounds_by_phone_number/:phone_number	Returns list of outbounds, which contain given phone number.
POST	outbound_status_by_phone_number	Update outbound status by phone number.
POST	outbounds/:id/records	Adds outbound record.
PUT	outbounds/:id/records/:phone_number	Updates outbound records.
PUT	outbounds/:id/records_by_identifier/:identifier	Updates outbound records.

CSV outbounds (batch)

HTTP	Resource	Description
DELETE	batch/outbounds/:id/records	Deletes many records from outbound.
POST	batch/outbounds/:id/records	Adds multiple outbound records.
PUT	batch/outbounds/:id/records	Updates many outbound records.

Outbounds groups

HTTP	Resource	Description
GET	outbound_groups	Return group of outbounds list.
GET	outbound_groups/:id	Return group of outbounds.
POST	outbound_groups	Add group of outbounds.

Queues

HTTP	Resource	Description
GET	queues	Returns a list of queues.
GET	queues/:id/topics	Returns call topics for the specified queue.
GET	queues/:id/waiting_list	Returns phone numbers waiting in queue.
GET	queues/:id/waiting_stats	Returns number of customers waiting in the queue and approx wait time.
POST	queues/:id/schedule_call	Schedule call, which will be make in queue.

Recordings

HTTP	Resource	Description
DELETE	recordings	Marks recording to be removed.
GET	recordings	Returns recordings matching a specified query.
GET	recordings/download	Returns the specified recording file.
GET	recordings/stream	Streams the specified recording file.

Files

HTTP	Resource	Description
GET	downloads/:id/attached_file	Downloads customer attached file.
GET	files/:token	Downloads a file.

Temporary files

HTTP	Resource	Description
POST	temporary_files	Creates a temporary file.

Connections

HTTP	Resource	Description
GET	connections	Returns connections matching a specified query.
GET	connections/:id/topic	Returns call topic.
POST	connections/:id/hangup	Hangs up the specified connection.
POST	connections/call	Makes a call to the specified number.
POST	connections/topic	Creates or updates the call topic for the specified connection.

Forwardings

HTTP	Resource	Description
DELETE	forwardings/:id	Deletes the specified forwarding.
GET	forwardings	Returns forwardings matching a specified query.
POST	forwardings	Adds a new forwarding.
PUT	forwardings/:id	Updates forwarding.

System

HTTP	Resource	Description
GET	system/pauses	Returns pauses.
GET	system/transfer_shortcuts	Returns transfer shortcuts.
PUT	system/announcement	Set announcement fot the users.

Users

HTTP	Resource	Description
GET	users/:login	Returns user info with assigned SIP accounts.

Tickets

HTTP	Resource	Description
DELETE	tickets/:id	Removes the specified ticket.
GET	ticket_categories	Returns list of ticket categories.
GET	ticket_queues	Returns list of ticket queues.
GET	ticket_statuses	Returns list of ticket statuses.
GET	tickets	Returns list of tickets.
GET	tickets/:id	Returns ticket details.
GET	tickets/today_stats	Returns tickets stats for current day.
POST	tickets	Adds a ticket.
POST	tickets/:id/comment	Add comment to a ticket.
POST	tickets/:id/customer_response	Add customer response to a ticket.
PUT	tickets/:id	Edit a ticket.

IVR

HTTP	Resource	Description
PUT	ivr/:branch/activate	Activates IVR branch.
PUT	ivr/:branch/deactivate	Deactivates IVR branch.
PUT	ivr/:branch/prompt_file	Updates prompt file.

Customer special field groups

HTTP	Resource	Description
GET	customer_field_groups	Returns a collection of customers spacial field groups.

Customer special field records

HTTP	Resource	Description
DELETE	customer_field_group_items/:id	Removes the specified customer field group item.
GET	customer_field_group_items	Returns a collection of customers spacial field items.
POST	customer_field_group_items	Adds a new custom field group item to a customer.
PUT	customer_field_group_items/:id	Updates a customer field group item.

Webhooks

HTTP	Resource	Description
DELETE	webhooks/:id	Deletes the webhook.
GET	webhooks	Returns all webhooks.
POST	webhooks	Adds a webhook.

Voicebot

HTTP	Resource	Description
POST	voicebots/:name/calls/:call_id/transcript	Adds a transcription of voicebot call.

Call topics

HTTP	Resource	Description
GET	topics	Returns active call topics.