Skip to content

Commit

Permalink
Document Check CID callflow action (2600hz#6456)
Browse files Browse the repository at this point in the history
  • Loading branch information
jamesaimonetti authored Apr 9, 2020
1 parent 506de09 commit 06d9546
Showing 1 changed file with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions applications/callflow/doc/check_cid.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,42 @@ Key | Description | Type | Default | Required | Support Level






## Example

### Absolute mode

When `use_absolute_mode` is `true`, a child branch is attempted if it matches the caller ID number exactly; otherwise the default child `"_"` is taken.

```json
{"module":"check_cid"
,"data":{
"use_absolute_mode":true
,"regex":"\\+?1?(\\d{10})"
}
,"children":{
"_":{...no matching branches for the caller ID...}
"+14158867900":{...If caller ID matches +14158867900...}
}
}
```

### Match / No Match

When `use_absolute_mode` is `false`, two child branches can be taken, "match" and "nomatch", based on whether the regex matched the caller ID.

```json
{"module":"check_cid"
,"data":{
"use_absolute_mode":false
,"regex":"\\+?1?(\\d{10})"
}
,"children":{
"match": { // callflow node to branch to when absolute mode is false and regex matches },
"nomatch": { // callflow node to branch to when regex does not match or no child node defined for incoming caller id },

}
}
```

0 comments on commit 06d9546

Please sign in to comment.