API Docs for: 2.6
Show:

plugin_rest_astproxy Class

Module: plugins_rest
Parent Module: com_ast_proxy_rest

REST plugin that provides asterisk functions through the following REST API:

GET requests

  1. astproxy/cw/:endpoint
  2. astproxy/dnd/:endpoint
  3. astproxy/cfvm/:type/:endpoint
  4. astproxy/unauthe_call/:endpoint/:number
  5. astproxy/prefix
  6. astproxy/remote_prefixes
  7. astproxy/cfcall/:type/:endpoint
  8. astproxy/queues
  9. astproxy/trunks
  10. astproxy/opgroups
  11. astproxy/conference/:endpoint
  12. astproxy/remote_opgroups
  13. astproxy/parkings
  14. astproxy/extensions
  15. astproxy/remote_extensions
  16. astproxy/sip_webrtc
  17. astproxy/queues_stats/:day
  18. astproxy/queue_recall/:type/:val/:qid
  19. astproxy/qrecall_info/:type/:val/:cid
  20. astproxy/qrecall_check/:num
  21. astproxy/queues_qos/:day
  22. astproxy/agents_qos/:day
  23. astproxy/is_autoc2c_supported/:endpoint

astproxy/cw/:endpoint

Gets the call waiting status of the endpoint of the user

  • endpoint: the extension identifier

Example JSON response:

{
    "exten": "614",
    "cw": "on"
}

astproxy/dnd/:endpoint

Gets the don't disturb status of the endpoint of the user. The endpoint is the extension identifier.

Example JSON response:

{
    "exten": "614"
    "dnd": "off"
}

astproxy/cfvm/:type/:endpoint

Gets the call forward status to voicemail of the endpoint of the user

  • endpoint: the extension identifier
  • type: ("unconditional" | "unavailable" | "busy")

Example JSON response:

{
    "exten": "614"
    "status": "off"
    "cf_type": "unconditional"
}

astproxy/unauthe_call/:endpoint/:number

Calls a number from the specified endpoint. This api does not require the authentication. It is disabled by default, so it must be explicitly enabled by the server configuration.

  • number: the number to be called
  • endpoint: the endpoint identifier that makes the new call

astproxy/prefix

Returns the prefix number used with outgoing external calls.

Example JSON response:

{
    "prefix": "0039"
}

astproxy/remote_prefixes

Returns the prefix number of all remote sites used with outgoing external calls.

Example JSON response:

{
    "site1": "6",
    "site2": "7"
}

astproxy/cfcall/:type/:endpoint

Gets the call forward status to a destination number of the endpoint of the user

  • endpoint: the extension identifier
  • type: ("unconditional" | "unavailable" | "busy")

Example JSON response:

{
    "exten": "614"
    "status": "off"
    "type": "unconditional"
 }

astproxy/queues

Gets the queues of the operator panel of the user.

Example JSON response:

{
    "501": {
          "name": "hold501",
          "queue": "501",
          "members": {
             "609": {
                 "type": "dynamic",
                 "name": "",
                 "queue": "501",
                 "member": "609",
                 "paused": false,
                 "loggedIn": false,
                 "callsTakenCount": 0,
                 "lastCallTimestamp": 0,
                 "lastPausedInReason": "",
                 "lastPausedInTimestamp": 0,
                 "lastPausedOutTimestamp": 0
             }
          },
          "avgHoldTime": "0",
          "avgTalkTime": "0",
          "waitingCallers": {},
          "completedCallsCount": "0",
          "abandonedCallsCount": "0",
          "serviceLevelTimePeriod": "60",
          "serviceLevelPercentage": "0.0"
      }
}

astproxy/trunks

Gets the trunks of the operator panel of the user.

Example JSON response:

{
    "2001": {
          "ip": "",
          "port": "",
          "name": "",
          "exten": "2001",
          "status": "offline",
          "chanType": "sip",
          "maxChannels": 4,
          "sipuseragent": "",
          "conversations": {}
    }
}

astproxy/opgroups

Gets the user groups of the operator panel of the local site.

Example JSON response:

{
    "Development": {
         "users": [
             "name5",
             "name6",
             "name7"
         ]
     }
}

astproxy/remote_opgroups

Gets the user groups of the operator panel of all remote sites.

Example JSON response:

{
    "nethesis",
        "Development": {
             "users": [
                 "name5",
                 "name6",
                 "name7"
             ]
         }
    },
    "ranocchi",
        "Support": {
             "users": [
                 "name1",
                 "name2",
                 "name3"
             ]
         }
    }
}

astproxy/conference/:endpoint

Gets the data about the extension meetme conference.

Example JSON response:

{
    "id": "202",
    "users": {
        "1": {
            "id": "1",
            "name": "202",
            "owner": true,
            "muted": false,
            "extenId": "202"
        }
    }
}

astproxy/parkings

Gets all the parkings with all their status informations.

Example JSON response:

{
    "71": {
         "name": "71",
         "parking": "71",
         "parkedCaller": {}
     }
}

astproxy/extensions

Gets all the extensions with all their status informations.

Example JSON response:

{
    "602": {
         "ip": "",
         "cf": "",
         "dnd": false,
         "cfVm": "",
         "port": "",
         "name": "cristian",
         "exten": "602",
         "status": "offline",
         "chanType": "sip",
         "sipuseragent": "",
         "conversations": {}
     }
}

astproxy/remote_extensions

Gets all the extensions with all their status informations of all remote sites.

Example JSON response:

{
    "nethesis": {
        "602": {
             "ip": "",
             "cf": "",
             "dnd": false,
             "cfVm": "",
             "port": "",
             "name": "cristian",
             "exten": "602",
             "status": "offline",
             "chanType": "sip",
             "sipuseragent": "",
             "conversations": {}
         }
    }
}

astproxy/sip_webrtc

Gets all the configuration about the sip WebRTC.

Example JSON response:

{
    "stun_server_address": "stun.l.google.com:19302"
}

astproxy/queues_stats/:day

Gets extended statistics about queues. The day must be expressed in YYYYMMDD format.

Example JSON response:

{
    "general": {
         "401": {
             "ANSWER": {
                 "4": 3,
                 "5": 6,
                 "7": 3,
                 "8": 1,
                 "9": 1,
                 "13": 1,
                 "15": 1,
                 "18": 1,
                 "28": 1,
                 "43": 1,
                 "140": 1
             },
             "ABANDON": {
                 "nulled": 6
             },
             "TIMEOUT": 0
         }
     },
     "answer": {
         "401": {
             "queuename": "401",
             "calls": 20,
             "max_hold": 140,
             "min_hold": 4,
             "avg_hold": 16.85,
             "max_duration": 1057,
             "min_duration": 12,
             "avg_duration": 289.9,
             "id": null
         }
     }
}

astproxy/queue_recall/:type/:val/:qid

Gets the recall data about the queue. The request must contains the following parameters:

  • type: ("day | "hours") the type of the interval time to be searched
  • val: in case of _type=hours_ is the amount of last hours to be searched, while in case of _type=day_ is the single day date expressed using the format YYYYMMDD
  • qid: the queue identifier

Example JSON response:

{
    company: "Nethesis",
    cid: "0721405516",
    action: "RECALL",
    time: "2015-12-30 17:21:45.2990102,
    qname: 2401"
}

astproxy/qrecall_check/:num

Check if the number is already in a conversation. The num is the number to be checked.

Example JSON response:

{
    inConversation: true
}

astproxy/qrecall_info/:type/:val/:cid

Gets details about the queue call. The request must contains the following parameters:

  • type: ("day | "hours") the type of the interval time to be searched
  • val: in case of _type=hours_ is the amount of last hours to be searched, while in case of _type=day_ is the single day date expressed using the format YYYYMMDD
  • cid: the caller identifier

Example JSON response:

{
    action: "DONE"
    cid: "0721405516"
    company: "Nethesis"
    qname: "IN"
    time: "2015-12-30T12:57:18.000Z"
}

astproxy/queues_qos/:day

Gets QOS info about queues. The day must be expressed in YYYYMMDD format.

Example JSON response:

[
    {
          "agent": "Andrea Marchionni"
          "period: "23-01-2014"
          "queuename: "401"
          "calls: 1
          "tot_duration: 47
          "max_duration: 47
          "min_duration: 47
          "avg_duration: 47
          "id: null
          "ringnoanswers: 21
    }
]

astproxy/agents_qos/:day

Gets QOS info about agents. The day must be expressed in YYYYMMDD format.

Example JSON response:

{
    "join_leave_queue": {},
    "pause_unpause": {},
    "logon_logoff": {},
    "inqueue_outqueue": {}
}

astproxy/is_autoc2c_supported/:endpoint

Returns true if the endpoint is supported by the automatic click2call.

  • endpoint: the extension identifier

Example JSON response:

{
    "exten": "614",
    "agent": "Yealink SIP-T22P 7.72.0.25",
    "supported": true
}

POST requests

  1. astproxy/cw
  2. astproxy/dnd
  3. astproxy/park
  4. astproxy/call
  5. astproxy/remote_call
  6. astproxy/cfvm
  7. astproxy/mute
  8. astproxy/unmute
  9. astproxy/cfcall
  10. astproxy/atxfer
  11. astproxy/answer
  12. astproxy/hangup
  13. astproxy/intrude
  14. astproxy/end_conf
  15. astproxy/send_dtmf
  16. astproxy/call_echo
  17. astproxy/start_spy
  18. astproxy/txfer_tovm
  19. astproxy/start_conf
  20. astproxy/join_myconf
  21. astproxy/pickup_conv
  22. astproxy/stop_record
  23. astproxy/mute_record
  24. astproxy/start_record
  25. astproxy/force_hangup
  26. astproxy/mute_userconf
  27. astproxy/hangup_userconf
  28. astproxy/unmute_userconf
  29. astproxy/answer_webrtc
  30. astproxy/blindtransfer
  31. astproxy/unmute_record
  32. astproxy/hangup_channel
  33. astproxy/pickup_parking
  34. astproxy/queuemember_add
  35. astproxy/inout_dyn_queues
  36. astproxy/queuemember_pause
  37. astproxy/queuemember_remove
  38. astproxy/queuemember_unpause
  39. astproxy/blindtransfer_queue
  40. astproxy/blindtransfer_parking

astproxy/cw

Sets the call waiting status of the endpoint of the user. The request must contains the following parameters:

  • endpoint: the extension identifier
  • status: ("on" | "off")

Example JSON request parameters:

{ "endpoint": "214", "status": "on" }

astproxy/cfcall

Sets the call forward status of the endpoint of the user to a destination number. The request must contains the following parameters:

  • endpoint: the extension identifier
  • status: ("on" | "off")
  • type: ("unconditional" | "unavailable" | "busy")
  • [to]: the destination number (optional when the status is off)

Example JSON request parameters:

{ "endpoint": "214", "status": "on", "type": "unconditional", "to": "340123456" }
{ "endpoint": "214", "status": "off", "type": "unconditional" }

Note: astproxy/cfcall and astproxy/cfvoicemail are mutually exclusive because both of them use the same property in the asterisk server database. So, e.g. setting the status to off for astproxy/cfcall type, automatically set to off also the astproxy/cfvm type and vice versa. Or setting to on the astproxy/cfcall type, automatically set to off the astproxy/cfvm type.


astproxy/cfvm

Sets the call forward status of the endpoint of the user to voicemail. The request must contains the following parameters:

  • endpoint: the extension identifier
  • status: ("on" | "off")
  • type: ("unconditional" | "unavailable" | "busy")
  • [to]: the destination voicemail identifier (optional when the status is off)

Example JSON request parameters:

{ "endpoint": "214", "status": "on", "type": "unconditional", "to": "209" }
{ "endpoint": "214", "status": "off", "type": "unconditional" }

Note: astproxy/cfcall and astproxy/cfvoicemail are mutually exclusive because both of them use the same property in the asterisk server database. So, e.g. setting the status to off for astproxy/cfcall type, automatically set to off also the astproxy/cfvm type and vice versa. Or setting to on the astproxy/cfcall type, automatically set to off the astproxy/cfvm type.


astproxy/mute

Mute audio of the conversation in one direction only. The specified endpointId is able to listen. The request must contains the following parameters:

  • convid: the conversation identifier
  • endpointId: the endpoint identifier that has the conversation to mute. The user must be the owner of the endpoint.
  • endpointType: the type of the endpoint that has the conversation to mute

Example JSON request parameters:

{ "convid": "SIP/214-000003d5>SIP/221-000003d6", "endpointType": "extension", "endpointId": "214" }

astproxy/unmute

Unmute audio of the conversation on both sides. The request must contains the following parameters:

  • convid: the conversation identifier
  • endpointId: the endpoint identifier that has the conversation to unmute. The user must be the owner of the endpoint.
  • endpointType: the type of the endpoint that has the conversation to unmute

Example JSON request parameters:

{ "convid": "SIP/214-000003d5>SIP/221-000003d6", "endpointType": "extension", "endpointId": "214" }

astproxy/dnd

Sets the don't disturb status of the endpoint of the user. The request must contains the following parameters:

  • status: (on|off)
  • endpoint

Example JSON request parameters:

{ "endpoint": "214", "status": "on" }

astproxy/park

Park a conversation. The user can park only his own conversations. The request must contains the following parameters:

  • convid: the conversation identifier
  • endpointId: the endpoint identifier that has the conversation to park
  • applicantId: the endpoint identifier who requested the parking. It is assumed that the applicant type is the same of the endpointType
  • endpointType: the type of the endpoint that has the conversation to park

Example JSON request parameters:

{ "convid": "SIP/214-000003d5>SIP/221-000003d6", "endpointType": "extension", "endpointId": "221", "applicantId": "216" }

astproxy/call

Calls a number from the specified endpoint. If the endpoint is not specified it will use the user default. The request must contains the following parameters:

  • number: the number to be called
  • [endpointId]: the endpoint identifier that make the new call. It requires "endpointType".
  • [endpointType]: ("extension" | "cellphone") the type of the endpoint that makes the new call. It requires "endpointId".

Example JSON request parameters:

{ "number": "0123456789" }
{ "number": "0123456789", "endpointType": "extension", "endpointId": "214" }

astproxy/remote_call

Calls a remote extension of a remote site from a local extension. If the local extension is not specified it will uses the user default. The request must contains the following parameters:

  • site: the remote site name
  • remoteExtenId: the remote extension to be called
  • [fromExtenId]: the local extension identifier that make the new call

Example JSON request parameters:

{ "site": "ranocchi", "remoteExtenId": "200" }
{ "site": "ranocchi", "remoteExtenId": "200", "fromExtenId": "300" }

astproxy/hangup

Hangup the specified conversation. The user can hangup whatever conversation only if he has the appropriate permission, otherwise he can hangup only his conversations. The request must contains the following parameters:

  • convid: the conversation identifier
  • endpointId: the endpoint identifier that has the conversation to hangup. If the user hasn't the permission of the advanced operator the endpointId must to be its endpoint identifier.
  • endpointType: the type of the endpoint that has the conversation to hangup

Example JSON request parameters:

{ "convid": "SIP/214-000003d5>SIP/221-000003d6", "endpointType": "extension", "endpointId": "214" }

astproxy/hangup_channel

Hangup the specified asterisk channel. The user can hangup only if he has the appropriate permission, otherwise he can hangup only his conversations. The request must contains the following parameters:

  • channel: the asterisk channel identifier
  • endpointId: the endpoint identifier that has the channel to hangup. If the user hasn't the permission of the advanced operator the endpointId must to be its endpoint identifier.
  • endpointType: the type of the endpoint that has the conversation to hangup

Example JSON request parameters:

{ "channel": "SIP/221-000003d6", "endpointType": "extension", "endpointId": "214" }

astproxy/blindtransfer

Transfer the conversation to the specified destination with blind type. The request must contains the following parameters:

  • to: the destination number to blind transfer the conversation
  • convid: the conversation identifier
  • endpointId: the endpoint identifier of the user who has the conversation to blind transfer
  • endpointType: the type of the endpoint of the user who has the conversation to blind transfer

Example JSON request parameters:

{ "convid": "SIP/214-000003d5>SIP/221-000003d6", "endpointType": "extension", "endpointId": "214", "to": "0123456789" }

astproxy/atxfer

Attended transfer the conversation to the specified destination. The request must contains the following parameters:

  • to: the destination number to transfer the conversation
  • convid: the conversation identifier
  • endpointId: the endpoint identifier of the user who has the conversation to attended transfer
  • endpointType: the type of the endpoint of the user who has the conversation to attended transfer

Example JSON request parameters:

{ "convid": "SIP/214-000003d5>SIP/221-000003d6", "endpointType": "extension", "endpointId": "214", "to": "221" }

astproxy/answer

Answer the conversation from the specified endpoint. If the endpoint is not specified it will use the user default. The request must contains the following parameters:

  • [endpointId]: the endpoint identifier of the user who has the conversation to answer. It requires "endpointType".
  • [endpointType]: the type of the endpoint of the user who has the conversation to answer. It requires "endpointId".

Example JSON request parameters:

{}
{ "endpointType": "extension", "endpointId": "214" }

astproxy/answer_webrtc

Answer the conversation from the specified webrtc endpoint. The server sends the answer command to the client that will answer the call. The request must contains the following parameters:

  • endpointId: the webrtc endpoint identifier of the user who has the conversation to answer.

Example JSON request parameters:

{ "endpointId": "214" }

astproxy/start_spy

Spy with only listening the specified conversation. The request must contains the following parameters:

  • convid: the conversation identifier
  • endpointId: the endpoint identifier of the user who has the conversation to spy
  • endpointType: the type of the endpoint of the user who has the conversation to spy
  • destId: the endpoint identifier that spy the conversation
  • destType: the type of the endpoint that spy the conversation

Example JSON request parameters:

{ "convid": "SIP/214-000003d5>SIP/221-000003d6", "endpointType": "extension", "endpointId": "221", "destType": "extension", "destId": "205" }

astproxy/txfer_tovm

Transfer the conversation to the specified voicemail. The request must contains the following parameters:

  • convid: the conversation identifier
  • username: the username that has the endpointId that has the conversation to transfer
  • endpointId: the endpoint identifier of the user who has the conversation to transfer
  • endpointType: the type of the endpoint of the user who has the conversation to transfer
  • voicemailId: the voicemail identifier to transfer the conversation. It's assumed that the destination type is the same of the endpoint type

Example JSON request parameters:

{ "username": "user", "convid": "SIP/214-000003d5>SIP/221-000003d6", "endpointType": "extension", "endpointId": "221", "voicemailId": "214" }

astproxy/start_conf

Starts a meetme conference. The request must contains the following parameters:

  • [site]: remote site name of the endpoint "addEndpointId" to be added. It can be absent or "local" to indicate local site
  • convid: the conversation identifier of the owner to be added to the conference
  • addEndpointId: the identifier of the extension to be added to the conference
  • ownerEndpointId: the extension identifier who wants to start the meetme conference

Example JSON request parameters:

{ "convid": "SIP/214-000003d5>SIP/221-000003d6", "ownerEndpointId": "202", "addEndpointId": "201" }
{ "convid": "SIP/214-000003d5>SIP/221-000003d6", "ownerEndpointId": "202", "addEndpointId": "201", "site": "nethesis" }

astproxy/pickup_conv

Pickup the specified conversation. The request must contains the following parameters:

  • convid: the conversation identifier
  • destId: the endpoint identifier that pickup the conversation
  • destType: the endpoint type that pickup the conversation
  • endpointId: the endpoint identifier that has the conversation to pickup
  • endpointType: the type of the endpoint that has the conversation to pickup

Example JSON request parameters:

{ "convid": ">SIP/221-000000", "endpointType": "extension", "endpointId": "221", "destType": "extension", "destId": "220"}

astproxy/stop_record

Stop the recording of the specified conversation. The request must contains the following parameters:

  • convid: the conversation identifier
  • endpointId: the endpoint identifier that has the conversation to stop recording
  • endpointType: the type of the endpoint that has the conversation to stop recording

Example JSON request parameters:

{ "convid": "SIP/214-000003d5>SIP/221-000003d6", "endpointType": "extension", "endpointId": "214" }

astproxy/start_record

Starts the recording of the specified conversation. The request must contains the following parameters:

  • convid: the conversation identifier
  • endpointId: the endpoint identifier that has the conversation to record
  • endpointType: the type of the endpoint that has the conversation to record

Example JSON request parameters:

{ "convid": "SIP/214-000003d5>SIP/221-000003d6", "endpointType": "extension", "endpointId": "214" }

astproxy/force_hangup

Force hangup of a conversation redirecting it to a non existent destination. The request must contains the following parameters:

  • convid: the conversation identifier
  • endpointId: the endpoint identifier that has the conversation to record
  • endpointType: the type of the endpoint that has the conversation to record

Example JSON request parameters:

{ "convid": "SIP/214-000003d5>SIP/221-000003d6", "endpointType": "extension", "endpointId": "214" }

astproxy/mute_userconf

Mute a user of a meetme conference. The request must contains the following parameters:

  • confId: the conference identifier
  • userId: the user identifier to be muted

Example JSON request parameters:

{ "confId": "202", "userId": "2" }

astproxy/unmute_userconf

Unmute a user of a meetme conference. The request must contains the following parameters:

  • confId: the conference identifier
  • userId: the user identifier to be muted

Example JSON request parameters:

{ "confId": "202", "userId": "2" }

astproxy/end_conf

Ends the entire meetme conference. The request must contains the following parameters:

  • confId: the conference identifier

Example JSON request parameters:

{ "confId": "202" }

astproxy/join_myconf

Joins the extension owner to his meetme conference. The request must contains the following parameters:

  • endpointId: the endpoint identifier

Example JSON request parameters:

{ "endpointId": "202" }

astproxy/hangup_userconf

Hangup a user of a meetme conference. The request must contains the following parameters:

  • confId: the conference identifier
  • extenId: the extension identifier to be hanged up

Example JSON request parameters:

{ "confId": "202", "extenId": "201" }

astproxy/mute_record

Mute the recording of the specified conversation. The request must contains the following parameters:

  • convid: the conversation identifier
  • endpointId: the endpoint identifier that has the conversation to record
  • endpointType: the type of the endpoint that has the conversation to record

Example JSON request parameters:

{ "convid": "SIP/214-000003d5>SIP/221-000003d6", "endpointType": "extension", "endpointId": "214" }

astproxy/pickup_parking

Pickup the specified parking. The request must contains the following parameters:

  • destId: the endpoint identifier that pickup the conversation
  • parking: the parking identifier
  • destType: the endpoint type that pickup the conversation

Example JSON request parameters:

{ "parking": "70", "destType": "extension", "destId": "214" }

astproxy/unmute_record

Unmute the recording of the specified conversation. The request must contains the following parameters:

  • convid: the conversation identifier
  • endpointId: the endpoint identifier that has the conversation to record
  • endpointType: the type of the endpoint that has the conversation to record

Example JSON request parameters:

{ "convid": "SIP/214-000003d5>SIP/221-000003d6", "endpointType": "extension", "endpointId": "214" }

astproxy/intrude

Intrudes into the specified conversation. Only the endpointId can listen and speak with the spier, its counterpart can not do that. The request must contains the following parameters:

  • convid: the conversation identifier
  • endpointId: the endpoint identifier that has the conversation to spy and speak
  • endpointType: the type of the endpoint that has the conversation to spy and speak
  • destId: the endpoint identifier that spy the conversation
  • destType: the endpoint type that spy the conversation

Example JSON request parameters:

{ "convid": "SIP/209-00000060>SIP/211-00000061", "endpointType": "extension", "endpointId": "209", "destType": "extension", "destId": "214" }

astproxy/send_dtmf

Sends the dtmf tone to the destination. The request must contains the following parameters:

  • tone: the tone to send. Permitted values are: 0 1 2 3 4 5 6 7 8 9 * #
  • convid: the conversation identifier
  • endpointId: the endpoint identifier
  • endpointType: the type of the endpoint

Example JSON request parameters:

{ "tone": "5", "convid": "SIP/214-000003d5>SIP/221-000003d6", "endpointType": "extension", "endpointId": "214" }

astproxy/call_echo

Originates a new echo call.

  • endpointId: the endpoint identifier
  • endpointType: the type of the endpoint

Example JSON request parameters:

{ "endpointType": "extension", "endpointId": "209" }

astproxy/queuemember_add

Adds the specified extension to the queue. The request must contains the following parameters:

  • endpointId: the endpoint identifier
  • endpointType: the type of the endpoint
  • queueId: the queue identifier
  • [paused]: the paused status
  • [penalty]: a penalty (number) to apply to the member. Asterisk will distribute calls to members with higher penalties only after attempting to distribute calls to those with lower penalty

Example JSON request parameters:

{ "endpointType": "extension", "endpointId": "209", "queueId": "401" }
{ "endpointType": "extension", "endpointId": "209", "queueId": "401", "paused": true, "penalty": 1 }

astproxy/inout_dyn_queues

Alternates the logon and logout of the specified extension in all the queues for which it's a dynamic member. The request must contains the following parameters:

  • endpointId: the endpoint identifier
  • endpointType: the type of the endpoint

Example JSON request parameters:

{ "endpointType": "extension", "endpointId": "209" }

astproxy/queuemember_pause

Pause the specified extension from receiving calls from the queue. The request must contains the following parameters:

  • endpointId: the endpoint identifier
  • endpointType: the type of the endpoint
  • [queueId]: the queue identifier. If omitted the pause is done in all queues
  • [reason]: the textual description of the reason

Example JSON request parameters:

{ "endpointType": "extension", "endpointId": "209", "queueId": "401", "reason": "some reason" }

astproxy/queuemember_remove

Removes the specified extension from the queue. The request must contains the following parameters:

  • endpointId: the endpoint identifier
  • endpointType: the type of the endpoint
  • queueId: the queue identifier

Example JSON request parameters:

{ "endpointType": "extension", "endpointId": "209", "queueId": "401" }

astproxy/queuemember_unpause

Unpause the specified extension to receiving calls from the queue. The request must contains the following parameters:

  • endpointId: the endpoint identifier
  • endpointType: the type of the endpoint
  • [queueId]: the queue identifier. If omitted the unpause is done in all queues

Example JSON request parameters:

{ "endpointType": "extension", "endpointId": "209", "queueId": "401" }

astproxy/blindtransfer_queue

Transfer the waiting caller from a queue to the specified destination using the blind type. The request must contains the following parameters:

  • to: the destination number
  • queue: the queue identifier
  • waitingCallerId: the identifier of the waiting caller

Example JSON request parameters:

{ "queue": "401", "waitingCallerId": "SIP/209-00000060", "to": "209" }

astproxy/blindtransfer_parking

Transfer the parked call to the specified destination using the blind type. The request must contains the following parameters:

  • to: the destination number
  • parking: the parking identifier

Example JSON request parameters:

{ "parking": "71", "to": "209" }

Methods

agents_qos

(
  • req
  • res
  • next
)

Gets QOS info about agents with the following REST API:

GET agents_qos

Parameters:

  • req Object

    The client request.

  • res Object

    The client response.

  • next Function

    Function to run the next handler in the chain.

ajaxPhoneAnswer

(
  • username
  • req
  • res
)

Answer to call from the extension sending an HTTP GET request to the phone device.

Parameters:

  • username String

    The username that originate the call

  • req Object

    The client request

  • res Object

    The client response

ajaxPhoneCall

(
  • username
  • req
  • res
)

Originates a new call sending an HTTP GET request to the phone device.

Parameters:

  • username String

    The username that originate the call

  • req Object

    The client request

  • res Object

    The client response

answer

(
  • req
  • res
  • next
)

Answers to a call with the following REST API:

POST answer

Parameters:

  • req Object

    The client request

  • res Object

    The client response

  • next Function

    Function to run the next handler in the chain

answer_webrtc

(
  • req
  • res
  • next
)

Answers a call directed to a webrtc extension sending the relative command to the client with the following REST API:

POST answer_webrtc

Parameters:

  • req Object

    The client request

  • res Object

    The client response

  • next Function

    Function to run the next handler in the chain

asteriskCall

(
  • username
  • req
  • res
)

Originates a new call by asterisk.

Parameters:

  • username String

    The username that originate the call

  • req Object

    The client request

  • res Object

    The client response

atxfer

(
  • req
  • res
  • next
)

Transfer a conversation with attended type with the following REST API:

POST atxfer

Parameters:

  • req Object

    The client request

  • res Object

    The client response

  • next Function

    Function to run the next handler in the chain

blindtransfer

(
  • req
  • res
  • next
)

Transfer a conversation with blind type with the following REST API:

POST blindtransfer

Parameters:

  • req Object

    The client request

  • res Object

    The client response

  • next Function

    Function to run the next handler in the chain

blindtransfer_parking

(
  • req
  • res
  • next
)

Transfer the parked call to the specified destination with blind type with the following REST API:

POST blindtransfer_parking

Parameters:

  • req Object

    The client request

  • res Object

    The client response

  • next Function

    Function to run the next handler in the chain

blindtransfer_queue

(
  • req
  • res
  • next
)

Transfer the waiting caller from the queue to the specified destination with blind type with the following REST API:

POST blindtransfer_queue

Parameters:

  • req Object

    The client request

  • res Object

    The client response

  • next Function

    Function to run the next handler in the chain

call

(
  • req
  • res
  • next
)

Makes a new call with the following REST API:

POST call

Parameters:

  • req Object

    The client request

  • res Object

    The client response

  • next Function

    Function to run the next handler in the chain

call

(
  • username
  • req
  • res
)

Originates a new call.

Parameters:

  • username String

    The username that originate the call

  • req Object

    The client request

  • res Object

    The client response

call_echo

(
  • req
  • res
  • next
)

Originates a new echo call with the following REST API:

POST call_echo

Parameters:

  • req Object

    The client request

  • res Object

    The client response

  • next Function

    Function to run the next handler in the chain

cfcall

(
  • req
  • res
  • next
)

Manages both GET and POST requests for call forward status to a destination number of the endpoint of the user with the following REST API:

GET  cfcall/:type/:endpoint
POST cfcall

Parameters:

  • req Object

    The client request

  • res Object

    The client response

  • next Function

    Function to run the next handler in the chain

cfcallGet

(
  • req
  • res
  • next
)

Gets the call forward status to a destination number of the endpoint of the user.

Parameters:

  • req Object

    The request object

  • res Object

    The response object

  • next Object

cfcallGetBusy

(
  • endpoint
  • username
  • res
)

Gets the call forward on busy status to a destination number of the endpoint of the user.

Parameters:

  • endpoint String

    The extension identifier

  • username String

    The username

  • res Object

    The response object

cfcallGetUnavailable

(
  • endpoint
  • username
  • res
)

Gets the call forward on unavailable status to a destination number of the endpoint of the user.

Parameters:

  • endpoint String

    The extension identifier

  • username String

    The username

  • res Object

    The response object

cfcallGetUnconditional

(
  • endpoint
  • username
  • res
)

Gets the unconditional call forward status to destination number of the endpoint of the user.

Parameters:

  • endpoint String

    The extension identifier

  • username String

    The username

  • res Object

    The response object

cfcallSet

(
  • req
  • res
  • next
)

Sets the call forward status of the endpoint of the user to a destination number.

Parameters:

  • req Object

    The request object

  • res Object

    The response object

  • next Object

cfcallSetBusy

(
  • endpoint
  • username
  • activate
  • [to]
  • res
)

Sets the call forward on busy status to a destination number of the endpoint of the user.

Parameters:

  • endpoint String

    The extension identifier

  • username String

    The username

  • activate Boolean

    True if the call forward on busy must be activated

  • [to] String optional

    The destination of the call forward on busy

  • res Object

    The response object

cfcallSetUnavailable

(
  • endpoint
  • username
  • activate
  • [to]
  • res
)

Sets the call forward unavailable status to a destination number of the endpoint of the user.

Parameters:

  • endpoint String

    The extension identifier

  • username String

    The username

  • activate Boolean

    True if the call forward unavailable must be activated

  • [to] String optional

    The destination of the call forward on unavailable

  • res Object

    The response object

cfcallSetUnconditional

(
  • endpoint
  • username
  • activate
  • [to]
  • res
)

Sets the unconditional call forward status to a destination number of the endpoint of the user.

Parameters:

  • endpoint String

    The extension identifier

  • username String

    The username

  • activate Boolean

    True if the unconditional call forward must be activated

  • [to] String optional

    The destination of the unconditional call forward

  • res Object

    The response object

cfvm

(
  • req
  • res
  • next
)

Manages both GET and POST requests for call forward status to voicemail of the endpoint of the user with the following REST API:

GET  cfvm/:type/:endpoint
POST cfvm

Parameters:

  • req Object

    The client request

  • res Object

    The client response

  • next Function

    Function to run the next handler in the chain

cfvmGet

(
  • req
  • res
  • next
)

Gets the call forward status to a voicemail of the endpoint of the user.

Parameters:

  • req Object

    The request object

  • res Object

    The response object

  • next Object

cfvmGetBusy

(
  • endpoint
  • username
  • res
)

Gets the call forward on busy status to voicemail of the endpoint of the user.

Parameters:

  • endpoint String

    The extension identifier

  • username String

    The username

  • res Object

    The response object

cfvmGetUnavailable

(
  • endpoint
  • username
  • res
)

Gets the call forward on unavailable status to voicemail of the endpoint of the user.

Parameters:

  • endpoint String

    The extension identifier

  • username String

    The username

  • res Object

    The response object

cfvmGetUnconditional

(
  • endpoint
  • username
  • res
)

Gets the unconditional call forward status to voicemail of the endpoint of the user.

Parameters:

  • endpoint String

    The extension identifier

  • username String

    The username

  • res Object

    The response object

cfvmSet

(
  • req
  • res
  • next
)

Sets the call forward status of the endpoint of the user to a destination voicemail.

Parameters:

  • req Object

    The request object

  • res Object

    The response object

  • next Object

cfvmSetBusy

(
  • endpoint
  • username
  • activate
  • [to]
  • res
)

Sets the call forward on busy status to voicemail of the endpoint of the user.

Parameters:

  • endpoint String

    The extension identifier

  • username String

    The username

  • activate Boolean

    True if the call forward on busy must be activated

  • [to] String optional

    The voicemail destination of the call forward on busy

  • res Object

    The response object

cfvmSetUnavailable

(
  • endpoint
  • username
  • activate
  • [to]
  • res
)

Sets the call forward unavailable status to a voicemail of the endpoint of the user.

Parameters:

  • endpoint String

    The extension identifier

  • username String

    The username

  • activate Boolean

    True if the call forward unavailable must be activated

  • [to] String optional

    The voicemail destination of the call forward on unavailable

  • res Object

    The response object

cfvmSetUnconditional

(
  • endpoint
  • username
  • activate
  • [to]
  • res
)

Sets the unconditional call forward status to a voicemail of the endpoint of the user.

Parameters:

  • endpoint String

    The extension identifier

  • username String

    The username

  • activate Boolean

    True if the unconditional call forward must be activated

  • [to] String optional

    The voicemail destination of the unconditional call forward

  • res Object

    The response object

conference

(
  • req
  • res
  • next
)

It serves only the local clients: the remote sites can not ask for it. Gets the meetme conference of the extension with the following REST API:

GET  conference/:endpoint

Parameters:

  • req Object

    The client request

  • res Object

    The client response

  • next Function

    Function to run the next handler in the chain

cw

(
  • req
  • res
  • next
)

Manages both GET and POST requests for don't disturb status of the endpoint of the user with the following REST API:

GET  cw/:endpoint
POST cw

Parameters:

  • req Object

    The client request.

  • res Object

    The client response.

  • next Function

    Function to run the next handler in the chain.

cwget

(
  • req
  • res
  • next
)

Gets the call waiting status of the endpoint of the user.

Parameters:

  • req Object

    The request object

  • res Object

    The response object

  • next Object

cwset

(
  • req
  • res
  • next
)

Sets the call waiting status of the endpoint of the user.

Parameters:

  • req Object

    The request object

  • res Object

    The response object

  • next Object

dnd

(
  • req
  • res
  • next
)

Manages both GET and POST requests for don't disturb status of the endpoint of the user with the following REST API:

GET  dnd/:endpoint
POST dnd

Parameters:

  • req Object

    The client request.

  • res Object

    The client response.

  • next Function

    Function to run the next handler in the chain.

dndget

(
  • req
  • res
  • next
)

Gets the don't disturb status of the endpoint of the user.

Parameters:

  • req Object

    The request object

  • res Object

    The response object

  • next Object

dndset

(
  • req
  • res
  • next
)

Sets the don't disturb status of the endpoint of the user.

Parameters:

  • req Object

    The request object

  • res Object

    The response object

  • next Object

end_conf

(
  • req
  • res
  • next
)

Ends the entire meetme conference with the following REST API:

POST end_conf

Parameters:

  • req Object

    The client request

  • res Object

    The client response

  • next Function

    Function to run the next handler in the chain

extensions

(
  • req
  • res
  • next
)

Gets all the parkings with all their status informations with the following REST API:

GET  parkings

Parameters:

  • req Object

    The client request.

  • res Object

    The client response.

  • next Function

    Function to run the next handler in the chain.

extensions

(
  • req
  • res
  • next
)

Gets all the extensions with all their status informations with the following REST API:

GET  extensions

Parameters:

  • req Object

    The client request.

  • res Object

    The client response.

  • next Function

    Function to run the next handler in the chain.

force_hangup

(
  • req
  • res
  • next
)

Force hangup of the specified conversation with the following REST API:

POST force_hangup

Parameters:

  • req Object

    The client request.

  • res Object

    The client response.

  • next Function

    Function to run the next handler in the chain.

hangup

(
  • req
  • res
  • next
)

Hangup a conversation with the following REST API:

POST hangup

Parameters:

  • req Object

    The client request.

  • res Object

    The client response.

  • next Function

    Function to run the next handler in the chain.

hangup_channel

(
  • req
  • res
  • next
)

Hangup the asterisk channel with the following REST API:

POST hangup_channel

Parameters:

  • req Object

    The client request

  • res Object

    The client response

  • next Function

    Function to run the next handler in the chain.

hangup_userconf

(
  • req
  • res
  • next
)

Hangup a user of a meetme conference with the following REST API:

POST hangup_userconf

Parameters:

  • req Object

    The client request

  • res Object

    The client response

  • next Function

    Function to run the next handler in the chain

inout_dyn_queues

(
  • req
  • res
  • next
)

Logon the extension in all the queues in which is dynamic member with the following REST API:

POST inout_dyn_queues

Parameters:

  • req Object

    The client request.

  • res Object

    The client response.

  • next Function

    Function to run the next handler in the chain.

intrude

(
  • req
  • res
  • next
)

Spy and speak in a conversation with the following REST API:

POST intrude

Parameters:

  • req Object

    The client request.

  • res Object

    The client response.

  • next Function

    Function to run the next handler in the chain.

is_autoc2c_supported

(
  • req
  • res
  • next
)

Returns true if the endpoint is supported by the automatic click2call with the following REST API:

is_autoc2c_supported/:endpoint

Parameters:

  • req Object

    The client request

  • res Object

    The client response

  • next Function

    Function to run the next handler in the chain

join_myconf

(
  • req
  • res
  • next
)

Joins the extension owner to his meetme conference with the following REST API:

POST join_myconf

Parameters:

  • req Object

    The client request

  • res Object

    The client response

  • next Function

    Function to run the next handler in the chain

mute

(
  • req
  • res
  • next
)

Unmute a conversation with the following REST API:

POST unmute

Parameters:

  • req Object

    The client request

  • res Object

    The client response

  • next Function

    Function to run the next handler in the chain

mute

(
  • req
  • res
  • next
)

Mute a conversation in one direction only. The specified endpointId is able to listen. It does this with the following REST API:

POST mute

Parameters:

  • req Object

    The client request

  • res Object

    The client response

  • next Function

    Function to run the next handler in the chain

mute_record

(
  • req
  • res
  • next
)

Mute the record of the specified conversation with the following REST API:

POST mute_record

Parameters:

  • req Object

    The client request

  • res Object

    The client response

  • next Function

    Function to run the next handler in the chain

mute_userconf

(
  • req
  • res
  • next
)

Mute a user of a meetme conference with the following REST API:

POST mute_userconf

Parameters:

  • req Object

    The client request

  • res Object

    The client response

  • next Function

    Function to run the next handler in the chain

opgroups

(
  • req
  • res
  • next
)

Gets the operator panel user groups of the local site with the following REST API:

GET  opgroups

Parameters:

  • req Object

    The client request

  • res Object

    The client response

  • next Function

    Function to run the next handler in the chain

park

(
  • req
  • res
  • next
)

Park a conversation with the following REST API:

POST park

Parameters:

  • req Object

    The client request.

  • res Object

    The client response.

  • next Function

    Function to run the next handler in the chain.

pickup_conv

(
  • req
  • res
  • next
)

Pickup a conversation with the following REST API:

POST pickup_conv

Parameters:

  • req Object

    The client request.

  • res Object

    The client response.

  • next Function

    Function to run the next handler in the chain.

pickup_parking

(
  • req
  • res
  • next
)

Pickup a parked call with the following REST API:

POST pickup_parking

Parameters:

  • req Object

    The client request

  • res Object

    The client response

  • next Function

    Function to run the next handler in the chain

prefix

(
  • req
  • res
  • next
)

Gets the prefix number used with outgoing external calls with the following REST API:

GET  prefix

Parameters:

  • req Object

    The client request

  • res Object

    The client response

  • next Function

    Function to run the next handler in the chain

qrecall_check

(
  • req
  • res
  • next
)

Checks if some user has just recalled the number with the following REST API:

GET qrecall_check

Parameters:

  • req Object

    The client request

  • res Object

    The client response

  • next Function

    Function to run the next handler in the chain

qrecall_info

(
  • req
  • res
  • next
)

Gets the details about the queue recall with the following REST API:

GET qrecall_info

Parameters:

  • req Object

    The client request

  • res Object

    The client response

  • next Function

    Function to run the next handler in the chain

queue_recall

(
  • req
  • res
  • next
)

Gets the recall data about the queue with the following REST API:

GET queue_recall

Parameters:

  • req Object

    The client request

  • res Object

    The client response

  • next Function

    Function to run the next handler in the chain

queuemember_add

(
  • req
  • res
  • next
)

Logon the extension in the queue in which is dynamic member with the following REST API:

POST queuemember_add

Parameters:

  • req Object

    The client request.

  • res Object

    The client response.

  • next Function

    Function to run the next handler in the chain.

queuemember_pause

(
  • req
  • res
  • next
)

Pause the specified extension from receiving calls from the queue with the following REST API:

POST queuemember_pause

Parameters:

  • req Object

    The client request

  • res Object

    The client response

  • next Function

    Function to run the next handler in the chain

queuemember_remove

(
  • req
  • res
  • next
)

Logout the extension from the queue in which is dynamic member with the following REST API:

POST queuemember_remove

Parameters:

  • req Object

    The client request.

  • res Object

    The client response.

  • next Function

    Function to run the next handler in the chain.

queuemember_unpause

(
  • req
  • res
  • next
)

Unpause the specified extension to receive calls from the queue with the following REST API:

POST queuemember_unpause

Parameters:

  • req Object

    The client request

  • res Object

    The client response

  • next Function

    Function to run the next handler in the chain

queueMemberPauseUnpause

(
  • req
  • res
  • paused
)

Pause or unpause an extension of a queue. The parameter "queueId" can be omitted. In this case the pause or unpause is done in all queues.

Parameters:

  • req Object

    The client request

  • res Object

    The client response

  • paused Boolean

    If the extension must be paused or unpaused. If it's true the extension will be paused from the queue.

queues

(
  • req
  • res
  • next
)

Gets all the queues with all their status informations with the following REST API:

GET  queues

Parameters:

  • req Object

    The client request.

  • res Object

    The client response.

  • next Function

    Function to run the next handler in the chain.

queues_qos

(
  • req
  • res
  • next
)

Gets QOS info about queues with the following REST API:

GET queues_qos

Parameters:

  • req Object

    The client request.

  • res Object

    The client response.

  • next Function

    Function to run the next handler in the chain.

queues_stats

(
  • req
  • res
  • next
)

Gets extended statistics about queues with the following REST API:

GET queues_stats

Parameters:

  • req Object

    The client request.

  • res Object

    The client response.

  • next Function

    Function to run the next handler in the chain.

remot_call

(
  • req
  • res
  • next
)

Makes a new call to a remote extension of a remote site with the following REST API:

POST remote_call

Parameters:

  • req Object

    The client request

  • res Object

    The client response

  • next Function

    Function to run the next handler in the chain

remote_extensions

(
  • req
  • res
  • next
)

Gets all the extensions with all their status informations of all remote sites with the following REST API:

GET  remote_extensions

Parameters:

  • req Object

    The client request

  • res Object

    The client response

  • next Function

    Function to run the next handler in the chain

remote_opgroups

(
  • req
  • res
  • next
)

It serves only the local clients: the remote sites can not ask for it. Gets the operator panel user groups of all remote sites with the following REST API:

GET  remote_opgroups

Parameters:

  • req Object

    The client request

  • res Object

    The client response

  • next Function

    Function to run the next handler in the chain

remote_prefixes

(
  • req
  • res
  • next
)

Gets the prefix number of all remote sites used with outgoing external calls with the following REST API:

GET  remote_prefixes

Parameters:

  • req Object

    The client request

  • res Object

    The client response

  • next Function

    Function to run the next handler in the chain

send_dtmf

(
  • req
  • res
  • next
)

Sends the dtmf code to the destination with the following REST API:

POST send_dtmf

Parameters:

  • req Object

    The client request

  • res Object

    The client response

  • next Function

    Function to run the next handler in the chain

setCompAstProxy

(
  • ap
)

Sets the asterisk proxy component used for asterisk functions.

Parameters:

  • ap Object

    The asterisk proxy component.

setCompAuthorization

(
  • comp
)
static

Set the authorization architect component.

Parameters:

  • comp Object

    The architect authorization component

setCompComNethctiRemotes

(
  • comp
)

Set remote sites communication architect component.

Parameters:

  • comp Object

    The remote sites communication architect component.

setCompComNethctiWs

(
  • comp
)
static

Set the websocket communication architect component.

Parameters:

  • comp Object

    The architect websocket communication component

setCompConfigManager

(
  • cm
)

Set configuration manager architect component used by configuration functions.

Parameters:

  • cm Object

    The configuration manager architect component.

setCompOperator

(
  • comp
)

Sets the operator architect component.

Parameters:

  • comp Object

    The operator architect component.

setCompUser

(
  • comp
)
static

Set the user architect component.

Parameters:

  • comp Object

    The architect user component

setCompUtil

(
  • comp
)

Sets the utility architect component.

Parameters:

  • comp Object

    The utility architect component.

setLogger

(
  • log
)
static

Set the logger to be used.

Parameters:

  • log Object

    The logger object. It must have at least three methods: info, warn and error as console object.

setPrivacy

(
  • str
)

Sets the string used to hide last digits of phone numbers in privacy mode.

Parameters:

  • str Object

    The string used to hide last digits of phone numbers.

sip_webrtc

(
  • req
  • res
  • next
)

Gets all the configuration about the sip WebRTC with the following REST API:

GET  sip_webrtc

Parameters:

  • req Object

    The client request

  • res Object

    The client response

  • next Function

    Function to run the next handler in the chain

start_conf

(
  • req
  • res
  • next
)

Transfer a conversation to the specified voicemail with the following REST API:

POST start_conf

Parameters:

  • req Object

    The client request

  • res Object

    The client response

  • next Function

    Function to run the next handler in the chain

start_record

(
  • req
  • res
  • next
)

Starts the record of the specified conversation with the following REST API:

POST start_record

Parameters:

  • req Object

    The client request.

  • res Object

    The client response.

  • next Function

    Function to run the next handler in the chain.

start_spy

(
  • req
  • res
  • next
)

Spy a conversation with only listening it with the following REST API:

POST start_spy

Parameters:

  • req Object

    The client request.

  • res Object

    The client response.

  • next Function

    Function to run the next handler in the chain.

stop_record

(
  • req
  • res
  • next
)

Stop the record of the specified conversation with the following REST API:

POST stop_record

Parameters:

  • req Object

    The client request.

  • res Object

    The client response.

  • next Function

    Function to run the next handler in the chain.

trunks

(
  • req
  • res
  • next
)

Gets all the trunks with all their status informations with the following REST API:

GET trunks

Parameters:

  • req Object

    The client request.

  • res Object

    The client response.

  • next Function

    Function to run the next handler in the chain.

txfer_tovm

(
  • req
  • res
  • next
)

Transfer a conversation to the specified voicemail with the following REST API:

POST txfer_tovm

Parameters:

  • req Object

    The client request

  • res Object

    The client response

  • next Function

    Function to run the next handler in the chain

unauthe_call

(
  • req
  • res
  • next
)

Makes a new call to the destination number from the endpoint of the user with the following REST API:

GET  unauthe_call/:endpoint/:number

Parameters:

  • req Object

    The client request

  • res Object

    The client response

  • next Function

    Function to run the next handler in the chain

unmute_record

(
  • req
  • res
  • next
)

Unmute the record of the specified conversation with the following REST API:

POST unmute_record

Parameters:

  • req Object

    The client request

  • res Object

    The client response

  • next Function

    Function to run the next handler in the chain

unmute_userconf

(
  • req
  • res
  • next
)

Unmute a user of a meetme conference with the following REST API:

POST unmute_userconf

Parameters:

  • req Object

    The client request

  • res Object

    The client response

  • next Function

    Function to run the next handler in the chain

Properties

compAstProxy

Object private

The asterisk proxy component used for asterisk functions.

compAuthorization

Object private

The architect component to be used for authorization.

compComNethctiRemotes

Object private

The remote sites communication architect component.

compComNethctiWs

Object private

The architect component to be used for websocket communication.

compConfigManager

Object private

The configuration manager architect component used for configuration functions.

compOperator

Object private

The architect component to be used for operator.

compUser

Object private

The architect component to be used for user.

compUtil

Object private

The utility architect component.

dtmfTonesPermitted

Object private

Dtmf tones permitted.

Default: [ '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '*', '#' ]

get

Array

REST API to be requested using HTTP POST request.

Sub-properties:

  • queues String

    Gets all the queues of the operator panel of the user

  • trunks String

    Gets all the trunks of the operator panel of the user

  • prefix String

    Gets the prefix number used with outgoing external calls

  • remote_prefixes String

    Gets prefix number of all remote sites used with outgoing external calls

  • opgroups String

    Gets all the user groups of the operator panel

  • remote_opgroups String

    Gets all the user groups of all remote sites

  • conference/:endpoint String

    Gets data about the meetme conference of the extension

  • parkings String

    Gets all the parkings with all their status informations

  • extensions String

    Gets all the extensions with all their status informations

  • sip_webrtc String

    Gets all the configuration about the sip WebRTC

  • remote_extensions String

    Gets all the extensions with all their status informations of all remote sites

  • queues_stats/:day String

    Gets extended statistics about queues

  • queue_recall/:type/:val/:qid String

    Gets the recall data about the queue

  • qrecall_info/:type/:val/:cid String

    Gets the details about the queue recall

  • qrecall_check/:num String

    Checks if the number is in conversation

  • queues_qos/:day String

    Gets QOS info about queues

  • agents_qos/:day String

    Gets QOS info about agents

  • cw/:endpoint String

    Gets the call waiting status of the endpoint of the user

  • dnd/:endpoint String

    Gets the don't disturb status of the endpoint of the user

  • cfvm/:type/:endpoint String

    Gets the call forward status to voicemail of the endpoint of the user

  • cfcall/:type/:endpoint String

    Gets the call forward status to a destination number of the endpoint of the user

  • unauthe_call/:endpoint/:number String

    Calls the number from the specified endpoint without authentication

  • is_autoc2c_supported/:endpoint String

    Returns true if the endpoint is supported by the automatic click2call

IDLOG

String private final

The module identifier used by the logger.

Default: [plugins_rest/astproxy]

logger

Object private

The logger. It must have at least three methods: info, warn and error.

Default: console

post

Array

REST API to be requested using HTTP POST request.

Sub-properties:

  • cw String

    Sets the call waiting status of the endpoint of the user

  • dnd String

    Sets the don't disturb status of the endpoint of the user

  • park String

    Park a conversation of the user

  • call String

    Make a new call

  • mute String

    Mute a call in one direction only. The specified endpointId is able to listen

  • cfvm String

    Sets the call forward status of the endpoint of the user to a destination voicemail

  • unmute String

    Unmute a call

  • cfcall String

    Sets the call forward status of the endpoint of the user to a destination number

  • atxfer String

    Transfer a conversation with attended type

  • answer String

    Answer a conversation from the extension

  • hangup String

    Hangup a conversation

  • intrude String

    Spy and speak in a conversation

  • end_conf String

    Ends the entire meetme conference

  • call_echo String

    Originates a new echo call

  • send_dtmf String

    Sends the dtmf tone to the destination

  • start_spy String

    Spy a conversation with only listening

  • txfer_tovm String

    Transfer the conversation to the voicemail

  • start_conf String

    Starts a meetme conference

  • join_myconf String

    Joins the extension owner to his meetme conference

  • pickup_conv String

    Pickup a conversation

  • stop_record String

    Stop the recording of a conversation

  • mute_record String

    Mute the recording of a conversation

  • start_record String

    Start the recording of a conversation

  • force_hangup String

    Force hangup of a conversation

  • mute_userconf String

    Mute a user of a meetme conference

  • answer_webrtc String

    Answer a conversation from the webrtc extension sending the command to the client

  • blindtransfer String

    Transfer a conversation with blind type

  • unmute_record String

    Unmute the recording of a conversation

  • hangup_channel String

    Hangup the asterisk channel

  • pickup_parking String

    Pickup a parked call

  • unmute_userconf String

    Unmute a user of a meetme conference

  • hangup_userconf String

    Hangup a user of a meetme conference

  • queuemember_add String

    Adds the specified extension to the queue

  • inout_dyn_queues String

    Alternates the logon and logout of the extension in all the queues for which it's a dynamic member

  • queuemember_pause String

    Pause the specified extension from receive calls from the queue

  • queuemember_remove String

    Removes the specified extension from the queue

  • queuemember_unpause String

    Unpause the specified extension to receive calls from the queue

  • blindtransfer_queue String

    Transfer a waiting caller from a queue to the destination with blind type

  • blindtransfer_parking String

    Transfer the parked call to the destination with blind type

privacyStrReplace

String private

The string used to hide phone numbers in privacy mode.

Default: "xxx"