Attributes

/ configuration / create

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

/ configuration / get

Method:/configuration /get
Parameters:
{
"match":
[
["category", "=", "DGS"],
["name", "=", "SMS"]
}
"return":["*"]
}
Response:
{
"error":0,
"result":
{
"id":id,
"category":"DGS",
"name":"SMS",
"description":"description",
"options":
'{
"provider":"clickatell",
"username":"john.smith",
"password":"secret"
}'
}
}

/ configuration / search

Method:/configuration /search
Parameters:
{
"match":
[
["category", "=", "DGS"],
["name", "=", "SMS"]
}
"return":["*"]
}
Response:
{
"error":0,
"result":
{
"total":1,
"rows":
[
{
"id":id,
"category":"DGS",
"name":"SMS",
"description":"description",
"options":
'{
"provider":"clickatell",
"username":"john.smith",
"password":"secret"
}'
}
]
}

/ configuration / delete

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

/ configuration / set

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

/ configuration / update

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

Configuration examples:

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

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

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

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

category:"CONNECTOR",
name:"TELEPHONE",
options:
'{
"provider":
{
"@name":"TeleSign",
"username":"",
"password":"",
"telephone":
{
"soap":
{
"variables":
[
{
"variable":
{
"@name":"custID ",
"@value":"xxx"
}
},
{
"variable":
{
"@name":"authID",
"@value":"xxx"
}
},
{
"variable":
{
"@name":"language",
"@value":"English"
},
},
{
"variable":
{
"@name":"redialCount",
"@value":"2"
},
…
}
]
}
}
}
}'

1. SMTP send Emergency Code template

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"
}'