Versions Compared

Version Old Version 2 New Version Current
Changes made by

Kelli Higdon

Merry Arpaia

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of Contents
minLevel1
maxLevel6
include
outlinefalse
indent
styledefault
exclude
typelist
class
printablefalse

...

Fetch Follow Me

Returns the follow me settings for a single extension.

...

Code Block
{
  "data": {
    "fetchFollowMe": {
      "id": "ZXh0ZW5zaW9uOaEwMw==",
      "message": "Record found successfully",
      "status": true,
      "enabled": false,
      "extensionId": "101",
      "strategy": "ringallv2",
      "ringTime": 20,
      "followMePrefix": null,
      "followMeList": "101-2317094162#",
      "callerMessage": null,
      "noAnswerDestination": "ext-local,101,dest",
      "alertInfo": null,
      "confirmCalls": null,
      "receiverMessageConfirmCall": null,
      "receiverMessageTooLate": null,
      "ringingMusic": "Ring",
      "initialRingTime": 7,
      "voicemail": "default",
      "enableCalendar": null,
      "calendar": null,
      "calendarGroup": null,
      "matchCalendar": true,
      "overrideRingerVolume": null,
      "externalCallerIdMode": "default",
      "fixedCallerId": null
    }
  }
}

Enable Follow Me

Enable follow me for the specified extension.

...

Code Block
{
  "data": {
    "enableFollowMe": {
      "message": "Follow me has been enabled",
      "status": true
    }
  }
}

Disable Follow Me

Disable follow me for the specified extension.

...

Code Block
{
  "data": {
    "disableFollowMe": {
      "message": "Follow me has been disabled",
      "status": true
    }
  }
}

Update Follow Me

Update the follow me settings. You can only set a value for either calendar or calendarGroup, but not both.

...

Code Block
{
  "data": {
    "updateFollowMe": {
      "message": "Follow me has been updated",
      "status": true
    }
  }
}

Enums

In GraphQL, the enum type is special kind of scalar that is restricted to a particular set of allowed values. When passed as input for a mutation, it should not be quoted like a string. However, due to the nature of JSON, when returned from a query it will be quoted.

ringstrategiesv2

Value

Description

ringallv2

Ring Extension for duration set in Initial Ring Time, and then, while continuing call to extension (only if extension is in the Group List), ring `followMeList` for duration set in `ringTime`.

ringallv2prim

Ring Extension for duration set in Initial Ring Time, and then, while continuing call to extension (only if extension is in the Group List), ring `followMeList` for duration set in `ringTime`. If the primary extension (first in list) is occupied, the other extensions will not be rung. If the primary is FreePBX DND, it won't be rung. If the primary is FreePBX CF unconditional, then all will be rung

ringall

Ring all available channels until one answers (default)

ringallprim

Ring all available channels until one answers. If the primary extension (first in list) is occupied, the other extensions will not be rung. If the primary is FreePBX DND, it won't be rung. If the primary is FreePBX CF unconditional, then all will be rung

hunt

Take turns ringing each available extension

huntprim

Take turns ringing each available extension. If the primary extension (first in list) is occupied, the other extensions will not be rung. If the primary is FreePBX DND, it won't be rung. If the primary is FreePBX CF unconditional, then all will be rung

memoryhunt

Ring first extension in the list, then ring the 1st and 2nd extension, then ring 1st 2nd and 3rd extension in the list.... etc

memoryhuntprim

Ring first extension in the list, then ring the 1st and 2nd extension, then ring 1st 2nd and 3rd extension in the list.... etc. If the primary extension (first in list) is occupied, the other extensions will not be rung. If the primary is FreePBX DND, it won't be rung. If the primary is FreePBX CF unconditional, then all will be rung

firstavailable

Ring only the first available channel

firstnotonphone

Ring only the first channel which is not offhook - ignore CW

externalcidmode

Value

Description

default

Default: Transmits the Callers CID if allowed by the trunk.

fixed

Fixed CID Value: Always transmit the Fixed CID Value below.

extern

Outside Calls Fixed CID Value: Transmit the Fixed CID Value below on calls that come in from outside only. Internal extension to extension calls will continue to operate in default mode.

did

Use Dialed Number: Transmit the number that was dialed as the CID for calls coming from outside. Internal extension to extension calls will continue to operate in default mode. There must be a DID on the inbound route for this. This will be BLOCKED on trunks that block foreign CallerID

forcedid

Force Dialed Number: Transmit the number that was dialed as the CID for calls coming from outside. Internal extension to extension calls will continue to operate in default mode. There must be a DID on the inbound route for this. This WILL be transmitted on trunks that block foreign CallerID

...