Versions Compared

Old Version 2

changes.mady.by.user Adam Darwin

Saved on

compared with

New Version Current

changes.mady.by.user Adam Darwin

Saved on

Key

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

Table of Contents

Anchor
_Toc341972561
_Toc341972561
Attributes

...

Method:/configuration /createParameters:
{

Code Block
languagejs
titleParameters
{
    "attrs":

...


    {
        "category":"DGS",

...


        "name":"SMS",

...


        "description":"description",

...


        "options":

...


         "{
             \"provider\":\"clickatell\",
             \"username\":\"john.smith\",

...


             \"password\":\"secret\"

...


         }"
    }
}


Code Block
languagejs
titleResponse
{
    "error":0

...


}

Anchor
_Toc341972563
_Toc341972563
/ configuration / get


Code Block
languagejs
titleParameters
{
Wiki Markup
Method:/configuration /get
Parameters: 
\{
 "match":
\    [
    \    ["category", "=", "DGS"\],
    \    ["name", "=", "SMS"\]
\}
    ],
    "return":\["*"\]
\}
Response: 
\{
}


Code Block
languagejs
titleResponse
{
    "error":0,
    "result":
\    {
        "id": "id",
        "category": "DGS",
        "name":"SMS",
        "description":"description",
        "options":
'\        "{
             \"provider\":\"clickatell\",
             \"username\":\"john.smith\",
             \"password\":\"secret\"
\}'
\}
\}
\\         }"
    }
}

Anchor
_Toc341972564
_Toc341972564
/ configuration / search


Code Block
languagejs
titleParameters
{
Wiki Markup
Method:/configuration /search
Parameters: 
\{
 "match":
\    [
        \["category", "=", "DGS"\],
        \["name", "=", "SMS"\]
\}
    ],
    "return":\["*"\]
\}
Response: 
\{
}


Code Block
languagejs
titleResponse
{
    "error":0,
    "result":
\    {
        "total": 1,
 "rows":
\[
\{
 "id":id,
  "category":"DGS",
 "name":"SMS",
 "description":"description",
 "options":
'\{
 "provider":"clickatell",
 "username":"john.smith",
 "password":"secret"
\}'
\}
\]
\}
\\
\\

...

Method:/configuration /delete
Parameters:
{
"id":id
}
Response:
{
"error":0
}

...

Method:/configuration /set
Parameters:
{
"id":id,
"attrs":
{
"description":"description",
"options":
'{
"provider":"clickatell",
"username":"john.smith",
"password":"secret"
}'
}
}
Response:
{
"error":0
}

...

Method:/configuration /update
Parameters:
{
"attrs":
{
"category":"DGS",
"name":"SMS",
"description":"description",
"options":
'{
"provider":"clickatell",
"username":"john.smith",
"password":"secret"
}'
}
}
Response:
{
"error":0
}

...

        "rows":
        [
             {
                  "id": "id",
                  "category": "DGS",
                  "name":"SMS",
                  "description":"description",
                  "options":
                  "{
                       \"provider\":\"clickatell\",
                       \"username\":\"john.smith\",
                       \"password\":\"secret\"
                   }"
             }
         ]
    }
}


Anchor
_Toc341972565
_Toc341972565
/ configuration / delete

Method:/configuration /delete

Code Block
languagejs
titleParameters
{
    "id": "configuration object id"
}


Code Block
languagejs
titleResponse
{
    "error":0
}

Anchor
_Toc341972566
_Toc341972566
/ configuration / set

Method:/configuration /set


Code Block
languagejs
titleParameters
{
    "id": "configuration object id",
    "attrs":
    {
        "category":"DGS",
        "name":"SMS",
        "description":"description",
        "options":
         "{
             \"provider\":\"clickatell\

...

  1. SMTP server:

category:"CONNECTOR",
name:"SMTP",
options:
'{
"doc":
{
"serverURI":"192.168.222.1",
"serverPort":25,
"authRequired":false,
"useTLS":false,
"userName":"",
"password":""
}
}'

  1. SMTP send OTP template
Wiki Markup
category:"TEMPLATE",
name:"SMTP_OTP",
options:
'\{
"subject":"OTP",
"from":"deepnetsecurity@gmail.com",
"to":"\[\[EMAIL\]\]",
"body":"Your one-time password: \[\[OTP\]\]",
"bodyFormat":"1",
"priority":"1"
\}'
  1. SMS settings
Wiki Markup
category:"CONNECTOR",
name:"SMS",
options:
'\{
 "provider":
 \{ 
  "@name":"Clickatell",
  "username":"deepnet",
  "password":"d33p5pace",
  "sms":
  \{
   "http":
   \{
    "variables":
    \[
     \{
      "variable":
      \{
       "@name":"api_id",
       "@value":"389965"
      \}
     \}
    \]
   \}
  \},
  "wap":
  \{
   "http":
   \{  
    "variables":
    \[
     \{
      "variable":
      \{
       "@name":"api_id",
       "@value":"389965"
      \}
     \}
    \]
   \}
  \}
 \}
\}'
\\
  1. SMS send OTP template
Wiki Markup
category:"TEMPLATE",
name:"SMS_OTP",
options:
'\{
 "from":"t.s.b@deepnetsecurity.com",
 "to":"\[\[MOBILE\]\]",
 "body":"Your one-time password: \[\[OTP\]\]"
\}'
\\
  1. Twitter settings:

category:"CONNECTOR",
name:"TWITTER",
options:
'{
"doc":
{ "serverURI":'http://twitter.com/direct_messages/new.xml',
"userName":"deepnet",
"password":"314159"
}
}'

  1. TeleSigh settings
Wiki Markup
category:"CONNECTOR",
name:"TELEPHONE",
options:
'\{
 "provider":
 \{ 
  "@name":"TeleSign",
  "username":"",
  "password":"",
  "telephone":
  \{
   "soap":
   \{
    "variables":
    \[
     \{
      "variable":
      \{
       "@name":"custID ",
       "@value":"xxx"
      \}
\},
\{
      "variable":"username\":\"john.smith\",
      \{
       \"@namepassword\":\"authIDsecret\",
         "@value":"xxx}"
      \}
\},
\{
  }
}


Code Block
languagejs
titleResponse
{
    "error":0
}


Anchor
_Toc341972567
_Toc341972567
/ configuration / update

Method:/configuration /update

This API will create the configuration if it doesn't exist. Or it will update it, if it already exists.

Code Block
languagejs
titleParameters
{
    "variableattrs":
      \{
        "@namecategory":"languageDGS",
        "@valuename":"EnglishSMS",
      \},
\},
\{
  "description":"description",
        "variableoptions":
         \"{
       "@name":"redialCount",
       \"@valueprovider\":\"2clickatell\",
      \},
       …\"username\":\"john.smith\",
     \}
    \]
   \}
  \}
\}
\}'
  1. SMTP send Emergency Code template
"password\":\"secret\"
         }"
    }
}


Code Block
languagejs
titleResponse
{
    "error":0
}
Wiki Markup
category:"TEMPLATE",
name:"SMTP_EC",
options:
'\{
"subject":"Your Emergency Code",
"from":"deepnetsecurity@gmail.com",
"to":"\[\[EMAIL\]\]",
"body":"Your emergency code: \[\[ECODE\]\], 
Usage Limit: \[\[LIMIT\]\], 
Expiry Date:\[\[EXPIRES\]\]",
Expiry Date:\[\[STARTS\]\]",
"bodyFormat":"1",
"priority":"1"
\}'
\\