Versions Compared

Key

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

...

Code Block
1. Api to add inbound route
 
GQLAPI:  /admin/api/api/gql
 
parameters:
 
mutation {
    addInboundRoute(input: {
          extension:"71667"
          cidnum:"1232abc1232"
          description:"Lorem Ipsum"
          privacyman:false
          alertinfo:"Lorem Ipsum"
          ringing:true
          mohclass:"Lorem Ipsum"
          grppre:"ABC"
          delay_answer:12
          pricid:false
          pmmaxretries:"123"
          pmminlength:"12"
          reversal:true
          rvolume:"12"
          fanswer:true
          destination:"1233"
    }) {
        inboundRoute {
          id
        }
        status
        message
    }
}

...

Code Block
{
  "data": {
    "addInboundRoute": {
      "inboundRoute": {
        "id": "71667/1232abc1232"
      }
      "status": true,
      "message": "Inbound Route created successfully"
    }
  }
}

...

Name

Required

Type

Default

Description

oldExtension

Optional

string

Old Extension. Used to change the current extension

oldCidnum

Optional

string

Old CID Num. Used to change the current cid number 

extension

Mandatory

string

Define the expected DID Number if your trunk passes DID on incoming calls.

cidnum

Mandatory

string

Define the CallerID Number to be matched on incoming calls. Can only be numbers, A-D, * and #. DID may also start with a +. Patterns must begin with an _ DID may also start with a +.

description

Optional

String

Provide a meaningful description of what this incoming route is

privacyman

Optional

Boolean

If no CallerID has been received, Privacy Manager will ask the caller to enter their phone number. If an user/extension has Call Screening enabled, 

the incoming caller will be prompted to say their name when the call reaches the user/extension.

alertinfo

Optional

String

ALERT_INFO can be used for distinctive ring with SIP devices.

ringing

Optional

Boolean

Some devices or providers require RINGING to be sent before ANSWER. You'll notice this happening if you can send calls directly to a phone, 

but if you send it to an IVR, it won't connect the call.

mohclass

Optional

String

Set the MoH class that will be used for calls that come in on this route. For example, choose a type appropriate for routes coming in from a 

country which may have announcements in their language.

grppre

Optional

String

CID name prefix

delay_answer

Optional

Integer

An optional delay to wait before processing this route. Setting this value will delay the channel from answering the call. 

This may be handy if external fax equipment or security systems are installed in parallel and you would like them to be able to seize the line.

pricid

Optional

Boolean

This effects CID ONLY routes where no DID is specified. If checked, calls with this CID will be routed to this route, even if there is a route to the DID that was called. 
Normal behavior is for the DID route to take the calls. If there is a specific DID/CID route for this CID, that route will still take the call when that DID is called

pmmaxretries

Optional

String

Number of attempts the caller has to enter a valid CallerID. Default value is 3

pmminlength

Optional

String

Minimum amount of digits CallerID needs to contain in order to be considered valid. Default value is 10

reversal

Optional

Boolean

On PRI channels the carrier will send a signal if the caller indicates a billing reversal. 
When checked this route will reject calls that indicate a billing reversal if supported

rvolume

Optional

String

Override the ringer volume. Note: This is only valid for Sangoma phones at this time. Default value is 0

fanswer

Optional

Boolean

Set to Yes to force the call to be answered at this time

destination

Mandatory

String

Destination for route

...