LinuxBox PBX API: REST API

Built:

2018-11-13 15:02:27


Function

REST /agent_call_bargein


Join agent into another agent call

Parameters:


userid TEXT user ID of barging agent


duserid TEXT user ID of destination agent

Returns:

TEXT status


Function

REST /agent_call_spy


Initiate agent call spy on another agent call

Parameters:


userid TEXT user ID of spying agent


duserid TEXT user ID of destination agent

Returns:

TEXT status


Function

REST /agent_call_transfer


Attended transfer of a call from one agent to another

Parameters:


userid TEXT user ID


duserid TEXT user ID of destination agent

Returns:

TEXT status


Function

REST /agent_call_transfer


Transfer call from one agent to another

Parameters:


userid TEXT user ID


duserid TEXT user ID of destination agent

Returns:

TEXT status


Function

REST /agent_call_whisper


Initiate agent whisper on another agent call

Parameters:


userid TEXT user ID of whispering agent


duserid TEXT user ID of destination agent

Returns:

TEXT status


Function

REST /agent_create


Create new agent

Parameters:


userid TEXT agent user ID

Returns:

TEXT status


Function

REST /agent_delete


Delete agent

Parameters:


userid TEXT agent user ID

Returns:

TEXT status


Function

REST /agent_dial


Dial call to agent

Parameters:


userid text user ID


number text target number


outgoing_cid_num text outgoing caller ID (number) (optional)

Returns:

text status


Function

REST /agent_hangup


Hangup pending agent call

Parameters:


userid TEXT user ID

Returns:

TEXT status


Function

REST /agent_login


Login agent

Parameters:


userid TEXT user ID


exten TEXT phone extensions


queues TEXT[] list of queues to login to (optional)

Returns:

TEXT status


Function

REST /agent_logout


Logout agent

Parameters:


userid TEXT user ID


reason TEXT logout reason (optional)

Returns:

TEXT status


Function

REST /agent_pause


Pause agent

Parameters:


userid TEXT agent user ID

Returns:

TEXT status


Function

REST /agent_set_attr


Set attribute for agent

Parameters:


userid TEXT agent user ID


attr JSON attribute(s) to set

Returns:

TEXT status


Function

REST /agent_skill_add


Add skill to agent

Parameters:


userid TEXT agent user ID


skillname TEXT name of the skill to add

Returns:

TEXT status


Function

REST /agent_skill_remove


Remove skill from agent

Parameters:


userid TEXT agent user ID


skillname TEXT name of the skill to remove

Returns:

TEXT status


Function

REST /agent_unpause


Unpause agent

Parameters:


userid TEXT agent user ID

Returns:

TEXT status


Function

REST /call_hangup


Request call hangup

Parameters:


call_id TEXT call ID

Returns:

TEXT status


Function

REST /call_hold


Put call on hold

Parameters:


call_id TEXT call ID

Returns:

TEXT status


Function

REST /call_transfer


Attended transfer of a call to destination extension at given context

Parameters:


call_id TEXT call ID


dexten TEXT destination extensions

Returns:

TEXT status


Function

REST /call_transfer


Transfer call to destination extension at given context

Parameters:


call_id TEXT call ID


dexten TEXT destination extensions

Returns:

TEXT status


Function

REST /exten_call_bargein


Join exten into another exten call

Parameters:


exten TEXT barging extension


dexten TEXT destination extension

Returns:

TEXT status


Function

REST /exten_call_pickup


Pickup ringing call by extension

Parameters:


call_id TEXT call ID


exten TEXT destination extension

Returns:

TEXT status


Function

REST /exten_call_spy


Initiate exten call spy on another extension call

Parameters:


exten TEXT spying extension


dexten TEXT destination extension

Returns:

TEXT status


Function

REST /exten_call_transfer


Attended transfer of a call from extension to another at given context

Parameters:


exten TEXT extension


dexten TEXT destination extension

Returns:

TEXT status


Function

REST /exten_call_transfer


Transfer call from extension to another at given context

Parameters:


exten TEXT extension


dexten TEXT destination extension

Returns:

TEXT status


Function

REST /exten_call_whisper


Initiate exten call whisper on another extension call

Parameters:


exten TEXT whispering extension


dexten TEXT destination extension

Returns:

TEXT status


Function

REST /exten_dial


Dial call to extension

Parameters:


exten TEXT phone extension


number TEXT target number


outgoing_cid_num TEXT outgoing caller identification (number)

Returns:

TEXT status


Function

REST /exten_hangup


Request exten call hangup

Parameters:


exten TEXT phone extension

Returns:

TEXT status


Function

REST /group_number_add


Add number to number group

Parameters:


number TEXT incoming number


group TEXT group name

Returns:

TEXT status


Function

REST /group_number_add


Add number to number group

Parameters:


number TEXT incoming number


group TEXT group name

Returns:

TEXT status


Function

REST /set_incoming_number


Set incoming number route to agent or exten

Parameters:


number TEXT incoming number


target_type TEXT target type („exten“/“agent“)


target TEXT target (exten or userid)

Returns:

TEXT status


Function

REST /sip_line_create


Provision new SIP line

Parameters:


linenum TEXT line number


description TEXT line description


secret TEXT line password

Returns:

TEXT status


Function

REST /sip_line_delete


Deprovision SIP line

Parameters:


linenum TEXT line number

Returns:

TEXT status