Grandstream GDS37, HTTP API User Manual

Grandstream GDS37, HTTP API User Manual

Grandstream Networks, Inc.

GDS37xx Door System

HTTP API

 

Table of Contents

 

CHANGE LOG...................................................................................................................................

4

HTTP API Version 1.0.0.36 ..........................................................................................................

4

HTTP API Version 1.0.0.32 ..........................................................................................................

4

HTTP API Version 1.0.0.28 ..........................................................................................................

4

HTTP API Version 1.0.0.25 ..........................................................................................................

4

HTTP API Version 1.0.0.23 ..........................................................................................................

4

HTTP API Version 1.0.0.18 ..........................................................................................................

5

HTTP API Version 1.0.0.13 ..........................................................................................................

5

SUPPORTED DEVICES ....................................................................................................................

6

OVERVIEW........................................................................................................................................

7

1.

Authentication ....................................................................................................................

8

2.

URL Parameter Definitions..............................................................................................

10

3.

XML Returned by Device.................................................................................................

10

PARAMETERS ................................................................................................................................

12

1.

Card Management ...........................................................................................................

12

2.

Door System Basic Settings ............................................................................................

16

3.

Keep Door Open..............................................................................................................

22

4.

Group...............................................................................................................................

24

5.

Schedule..........................................................................................................................

27

6.

Holiday.............................................................................................................................

29

7.

Date and Time .................................................................................................................

31

8.

Network Settings .............................................................................................................

34

9.

Access Settings ...............................................................................................................

36

10.

User Management ...........................................................................................................

38

11.

SIP Settings .....................................................................................................................

39

12.

White List .........................................................................................................................

45

13.

Video Settings..................................................................................................................

47

14.

On Screen Display (OSD) Settings .................................................................................

51

15.

CMOS Settings ................................................................................................................

53

16.

Audio Settings..................................................................................................................

55

17.

Privacy Masks..................................................................................................................

56

18.

Alarm Config ....................................................................................................................

58

19.

Alarm Schedule Configuration.........................................................................................

68

 

GDS37XX HTTP API

P a g e | 2

 

Version 1.0.0.36

 

20.

Alarm Action Configuration..............................................................................................

70

21.

Alarm Phone List .............................................................................................................

72

22.

Email Settings..................................................................................................................

73

23.

FTP Settings ....................................................................................................................

75

24.

Upgrade Configuration ....................................................................................................

77

25.

Reboot & Reset ...............................................................................................................

79

26.

Syslog or Debug ..............................................................................................................

82

27.

Data Maintenance ...........................................................................................................

83

28.

System Health Alert .........................................................................................................

83

29.

Event Notification.............................................................................................................

85

30.

Certificates.......................................................................................................................

87

31.

System Status..................................................................................................................

88

32.

Network Status ................................................................................................................

90

33.

Firmware Available Version Check..................................................................................

92

34.

Card Data Import/Export..................................................................................................

93

35.

OpenVPN Settings ..........................................................................................................

93

36.

TR069 Settings ................................................................................................................

95

HTTP API APPLICATION EXAMPLES ..........................................................................................

98

1.

General Parameter Revision ...........................................................................................

98

2.

JPEG (Snapshot)...........................................................................................................

105

3.

MJPEG Stream (Challenge Mode or Basic Mode)........................................................

109

4.

HTTP API to Open Door................................................................................................

119

Table of Figures

 

Figure 1: MJPEG Authentication Mode.........................................................................................

109

Figure 2: Video Settings................................................................................................................

112

Figure 3: Basic MJPEG Authentication .........................................................................................

115

Figure 4: Video settings ................................................................................................................

117

GDS37XX HTTP API

P a g e | 3

Version 1.0.0.36

 

CHANGE LOG

This section documents significant changes from previous versions of the GDS37xx_HTTP_API. Only major new features or major document updates are listed here. Minor updates for corrections or editing are not documented here.

HTTP API Version 1.0.0.36

Product Name: GDS3710 Firmware 1.0.7.23 / GDS3705 Firmware 1.0.1.12

Added PValues for TR069 [TR069 Settings]

Added Pvalue P15543 for One-way Interlocking Doors Mode [Door System Basic Settings]

Added Pvalue P15544 for Key Sensitivity Level [Door System Basic Settings]

Added Pvalues for Configurable Auto Reboot. [Reboot & Reset]

HTTP API Version 1.0.0.32

Product Name: GDS3710 Firmware 1.0.7.14 / GDS3705 Firmware 1.0.1.11

Added PValues P15440 to P15443 for Door Relay Options [Door System Basic Settings]

Added Pvalue P15514 for PIN Password Display in HTTPS [Door System Basic Settings]

Added Pvalue P4428 to Disable SIP Notify Authentication [Upgrade Configuration]

Added Pvalues for OpenVPN Settings [OpenVPN Settings]

HTTP API Version 1.0.0.28

Product Name: GDS3710 Firmware 1.0.7.7 / GDS3705 Firmware 1.0.1.3

Add RTSP Password. [Access Settings]

Update Unlock holding time, MAX to 1800. [Door System Basic Settings]

Add P2395/P2595/P2695. [GDS37XX Account Settings]

HTTP API Version 1.0.0.25

Product Name: GDS3710 Firmware 1.0.7.7 / GDS3705 Firmware 1.0.1.3

Added Pvalues P15508 and P15509 for Abnormal Door Control. [Alarm Config]

Added new HTTP API for abnormal door control. [Alarm Config]

Added Pvalues P15506 and P15507 for Holiday Mode [Keep Door Open]

HTTP API Version 1.0.0.23

Product Name: GDS3710 Firmware 1.0.7.4 / GDS3705 Firmware 1.0.1.3

Added Pvalue P1411 for “DHCP Option 120 Override SIP Server”. [Upgrade Configuration]

Updated ChallengeString. [JPEG (Snapshot)]

GDS37XX HTTP API

P a g e | 4

Version 1.0.0.36

 

Added Pvalues P2347/P2447/P2547/P2647 for Accept Incoming SIP from Proxy Only. [GDS37XX Account Settings]

Added Pvalues P57/P58/P59/P60 for Special Feature Telefonica Spain. [GDS37XX Account Settings]

Added Pvalues P37/P486/P586/P686 for Voice Frames per TX. [GDS37XX Account Settings]

Update P100 to P198 for Special Feature. [GDS37XX Account Settings]

Added Pvalue P2330 for Re-register before Expiration. [GDS37XX Account Settings]

Added Pvalues P57/P58/P59/P60 for preferred Vocoder. [GDS37XX Account Settings]

Added Pvalue P8458/P8459/P286 for Randomized Automatic Upgrade options. [Upgrade Configuration]

HTTP API Version 1.0.0.18

Product Name: GDS3710 Firmware 1.0.5.6 / GDS3705 Firmware 1.0.0.41

Added second door opening support on GDS3705 via command. [HTTP API to Open Door]

Added P-value 15473 on GDS3705 for option [Disable Web Access]

Added P-Values P79/P496/P596/P696 for option [DTMF Payload Type]

Added P-Values P293/P462/P562/P662 for option [H.264 Payload Type]

Added Multi-SIP account on GDS3710. [GDS37XX Account Settings]

Added White List for each of the 4 SIP accounts on GDS3710. [GDS37XX White List]

Added System Health Alert command. [System Health Alert]

HTTP API Version 1.0.0.13

Product Name: GDS3710 Firmware 1.0.5.2 / GDS3705 Firmware 1.0.0.37

Added P-value 15476 for option [Allow Reset Via SIP NOTIFY]

Added P-value 15473 for option [Disable Web Access]

Added P-value 15469 for option [Enable Anonymous LiveView]

Extended VLAN tag range from 0 to 4094 for option [Layer 2 QoS 802.1Q/VLAN Tag]

Added Firmware Available Version Check command [Firmware Available Version Check]

Added Card Data Import/Export commands [ Card Data Import/Export]

Added P-value 462 for H.264 Payload Type. [GDS37XX Account Settings]

GDS37XX HTTP API

P a g e | 5

Version 1.0.0.36

 

SUPPORTED DEVICES

The following table shows GDS37XX Grandstream products supporting HTTP API covered in this guide:

Model

 

Firmware

 

 

 

 

 

GDS3710

 

1.0.7.23

 

 

 

 

 

GDS3705

 

1.0.1.12

 

 

 

GDS37XX HTTP API

P a g e | 6

Version 1.0.0.36

OVERVIEW

Grandstream Door System Interface HTTP API (Application Programming Interface) supports RFC3550 (RTP).

This document explains in detail the external HTTP-based application programming interface and parameters of functions via the supported method. The HTTP API is firmware dependent. Please refer to the related firmware Release Note for the supported functions.

Administrator Privilege is required, and administrator authentication verification must be executed before any operation to the related parameter configuration.

Syntax:

Client Server

https://<servername>/goform/config?cmd=get&type=<module>

https://<servername>/goform/config?cmd=set&<param>=<value>&<param1>=<value>...

Notes:

<param> is used to identify the different parameter of functions.

<module> is used to identify the different module of functions.

GDS37XX HTTP API

P a g e | 7

Version 1.0.0.36

 

1. Authentication

Authentication is using encrypted Challenge / Response mode. After successful authentication, the user with administration privilege needs to include the authentication information in each request header of the operation before the operation can be executed.

The authentication process is shown as following:

Step 1:

Client Server

https://<servername>/goform/login?cmd=login&user=admin&type=0

Server Client

<?xml version="1.0"encoding="UTF-8" ?> <Configuration> <ResCode>0</ResCode>

<ChallengeCode>ChallengeString</ChallengeCode> <LoginType>0</LoginType> <RetMsg>OK</RetMsg>

</Configuration>

Step 2:

Client Server

https://<servername>/goform/login?cmd=login&user=admin&authcode=<authcodestrin

g>&type=0

Server Client

HTTP/1.0 200 OK Content-Type: text/xml;charset=UTF-8

Set-Cookie: session=ac81cade4c9d9264f50c45018fb02c12;path=/;

Set-Cookie: uname=admin;path=/;

Set-Cookie: level=1;path=/;

<?xml version="1.0"encoding="UTF-8" ?>

<Configuration> <ResCode>0</ResCode> <LoginType>0</<LoginType> <RetMsg>OK</RetMsg>

</Configuration>

GDS37XX HTTP API

P a g e | 8

Version 1.0.0.36

 

Notes:

The rule of authentication code string is generated via following rules:

authcodestring = md5(ChallengeString:GDS3710lZpRsFzCbM:password);

o ChallengeString is the reply strings from Server by Step 1

oPassword is the login password of the GDS37xx device.

The RED part of the string is the replied authentication information from Sever after successful authentication. Such information needs to exist in the operation message header of all the following operations, otherwise the operation is abnormal and will fail.

Example: Delete the card with ID number: 7465995

Client Server

POST /goform/config

HTTP/1.1

Host: 192.168.86.8

Connection: keep-alive

Content-Length: 26

Cache-Control: max-age=0

Origin: https://192.168.86.8

User-Agent: Mozilla/5.0 (Windows NT 6.1; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/57.0.2987.98 Safari/537.36

Content-Type: application/x-www-form-urlencoded; charset=UTF-8

Accept: application/xml, text/xml, */*; q=0.01

X-Requested-With: XMLHttpRequest

If-Modified-Since: 0

Referer: https://192.168.86.8/Pages/user_list.html?t=1496385815560

Accept-Encoding: gzip, deflate, br

Accept-Language: zh-CN,zh;q=0.8

Cookie: gdsauthkey4433=150e080c781be0deb8d5a8a2c6ed95d2; gdslanguage=zh; session=643e985e113a50979fd245762be01a57; uname=admin; level=1; gdsauthkey443=643e985e113a50979fd245762be01a57; curpage=user_list.html cmd=del&user_list=7465995,

Note:

The RED part of the string is the Authentication String MUST be carried in the header message by the cookie during operation

GDS37XX HTTP API

P a g e | 9

Version 1.0.0.36

 

Tips of HTTP API Usage:

In most situation, parameters fetched by using “GET” can be revised by using “SET”, except

Status or Display parameter information.

When using “SET”, sometimes there are inter-action or restrictions among those related parameters, all parameters must “SET” or configure correctly together before the device taking effect.

Please refer to related WebGUI page for reference if not sure about the HTTP API.

2.URL Parameter Definitions

<parameter>=<value> Values

add/del/set/get

cmd=<string> /reboot/reset/fw_upgrade

/export/upload

Description

Operation command type (Required):

add: add parameter or data del: delete parameter or data set: set device parameter

get: get command or parameter reboot: reboot device

reset: factory reset device

fw_upgrade: check FW version or upgrade FW export: export data

upload: import data

3. XML Returned by Device

Response

 

Response

 

Description

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Code

 

Text

 

 

 

 

 

 

 

 

 

 

 

0

 

OK

 

Success

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

1

 

 

 

User does not exist

 

 

 

 

 

 

 

 

 

2

 

 

 

Password error

 

 

 

 

 

 

 

 

 

3

 

 

 

Max login or max white list number

 

 

 

 

 

 

 

 

 

4

 

 

 

Phone number exist

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

5

 

 

 

Parameter should not be empty

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

6

 

 

 

Parameter contain illegal characters

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

7

 

 

 

Message sending error

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

8

 

 

 

New password not match

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

GDS37XX HTTP API

P a g e | 10

 

 

 

 

 

Version 1.0.0.36

 

 

9

 

 

 

FTP test error

 

 

 

 

 

 

 

 

 

 

 

 

 

10

 

 

 

Hostage passwd

 

 

 

 

 

 

 

 

 

 

11

 

 

 

Remote /Local PIN not same with hostage password

 

 

 

 

 

 

 

 

 

 

12

 

 

 

SMTP timeout

 

 

 

 

 

 

 

 

 

 

13

 

 

 

Retrieve Password (Account is no exist)

 

 

 

 

 

 

 

 

 

 

14

 

 

 

SMTP authentication failed

 

 

 

 

 

 

 

 

 

 

15

 

 

 

SMTP test failed

 

 

 

 

 

 

 

 

 

 

16

 

 

 

Invalid SMTP server

 

 

 

 

 

 

 

 

 

 

17

 

 

 

Email address is empty

 

 

 

 

 

 

 

 

 

 

18

 

 

 

Email test timeout

 

 

 

 

 

 

 

 

 

 

19

 

 

 

SIP is calling

 

 

 

 

 

 

 

 

 

 

401

 

 

 

Authentication failed

 

 

 

 

 

 

 

 

 

 

408

 

 

 

Session time out

 

 

 

 

 

Example:

Returned XML by device:

<?xml version="1.0"encoding="UTF-8" ?>

<Configuration> <ResCode>0</ResCode> <RetMsg>OK</RetMsg>

</Configuration>

GDS37XX HTTP API

P a g e | 11

Version 1.0.0.36

 

PARAMETERS

1. Card Management

Supported Devices: GDS3710/GDS3705

Method Supported:

cmd = get/add/set/del

Get:

http://<servername>/goform/config?cmd=get&type=user_list

Example:

 

 

 

 

 

 

 

<?xml version="1.0"encoding="UTF-8" ?>

 

 

<Configuration>

 

 

 

 

 

<ResCode>0</ResCode>

 

 

 

 

<RetMsg>OK</RetMsg>

 

 

 

 

<total>1</total>

 

 

 

 

<item>

 

 

 

 

 

<idx>0</idx>

<!-- index, assigned by system -->

 

 

 

<ID>1</ID>

<!-- card number -->

 

 

 

<room_num>1</room_num> <!-- virtual number -->

 

 

 

<sip_num>1</sip_num>

<!-- sip number -->

 

 

 

<username>1</username> <!-- user name -->

 

 

 

<passwd>1</passwd>

<!-- open door password -->

 

 

 

<gender>0</gender> <!-- gender -->

 

 

 

<identify_num>1</identify_num> <!-- ID number -->

 

 

 

<cellphone_num>1</cellphone_num> <!-- cellphone number -->

 

 

 

<EOD>20991231</EOD> <!-- card valid date -->

 

 

 

<enable_card>1</enable_card> <!-- enable or disable -->

 

 

 

</item>

 

 

 

 

 

<item>

 

 

 

 

 

<idx>2</idx>

 

 

 

 

 

<ID>2</ID>

 

 

 

 

 

<room_num>2</room_num>

 

 

 

<sip_num>2</sip_num>

 

 

 

 

<username>2</username>

 

 

 

<passwd>1</passwd>

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

GDS37XX HTTP API

P a g e | 12

 

 

 

Version 1.0.0.36

 

 

<gender>0</gender> <identify_num>2</identify_num> <cellphone_num>2</cellphone_num> <EOD>20991231</EOD> <enable_card>1</enable_card>

</item>

<item> <idx>2</idx> <ID>1</ID>

<room_num>1</room_num> <sip_num>1</sip_num> <username>1</username> <passwd>1</passwd> <gender>0</gender> <identify_num>1</identify_num> <cellphone_num>1</cellphone_num> <EOD>20991231</EOD> <enable_card>1</enable_card>

</item>

</Configuration>

Add / Set:

http://<servername>/goform/config?cmd=<add|set>&<parameter>=<value>...

Notes:

To add a new card to your card management database or edit an already created one; you will need to make sure to mention the 3 important fields in your request:

username; Card Number (ID); virtual number (room_number)

For example:

+ Add new Card:

https://192.168.1.162/goform/config?cmd=add&ID=258974&room_num=12&sip_num=12& username=Someone&passwd=236987&gender=1&identify_num=12&EOD=20991231

GDS37XX HTTP API

P a g e | 13

Version 1.0.0.36

 

+ Set the "enable_card" flag for that created card:

https://192.168.5.147/goform/config?cmd=set&ID=258974&room_num=12&username=Someone &sip_num=12&passwd=236987&gender=1&identify_num=12&EOD=20991231&enable_card=1

<parameter>=<value>

Values

Description

 

 

 

ID=<int>

Numeric Digits

RFID card number.

 

 

Unique and cannot be empty

 

 

 

room_num =<int>

Numeric Digits

Virtual Number (Room Number)

 

 

Cannot be empty

 

 

 

sip_num =<string>

Numeric Digits

SIP extension number (max.

 

 

length: 20)

 

 

Binding via SIP

 

 

 

username =<string>

Character Strings

Name (max. 32 characters).

 

 

Cannot be empty

 

 

 

passwd =<string>

Numeric Digits

PIN to open door

 

 

(max. length: 12)

 

 

 

gender =<int>

<0|1>

Gender

 

 

0 - Male (Default)

 

 

1 - Female

 

 

 

identify_num =<string>

 

ID Number (max. length: 20)

 

 

 

cellphone_num =<int>

 

Cell Number (max. length: 16)

 

 

 

SOD=<int>

 

Valid Start Date Format:

 

 

20171001 (YYYYMMDD)

 

 

Default: 19700101

 

 

 

EOD =<int>

 

Valid End Date Format:

 

 

20171001 (YYYYMMDD)

 

 

Default: 20991231

 

 

 

enable_card =<int>

<0|1>

Enable the RFID card

 

 

0: Disable

 

 

1: Enable

 

 

 

account

<0|1|2|3|4>

Call Out Account

 

 

0: Auto

 

 

1: Account 1

 

 

2: Account 2

 

 

3: Account 3

 

 

4: Account 4

 

 

 

GDS37XX HTTP API

P a g e | 14

Version 1.0.0.36

 

 

group_id

 

<0-50>

 

Group:

 

 

 

 

 

 

The group id must exist, or

 

 

 

 

 

 

group_id=0

 

 

 

 

 

 

 

 

 

sch_id

 

<0-10>

 

Schedule

 

 

 

 

 

 

0: Disable

 

 

 

 

 

 

 

 

 

 

 

 

 

 

1: Schedule 1

2: Schedule 2

3: Schedule 3

4: Schedule 4

5: Schedule 5

6: Schedule 6

7: Schedule 7

8: Schedule 8

9: Schedule 9

10: Schedule 10

Del:

http://<servername>/goform/config?cmd=del&ID=ID1,ID2,ID3,ID4,...

Notes:

To delete a card, you need only to mention the ID number which is the Card Number.

Max 20 cards can be deleted at the same time.

Example:

https://192.168.1.162/goform/config?cmd=del&ID=258974

<?xml version="1.0"encoding="UTF-8" ?>

<Configuration>

<ResCode>0</ResCode>

<RetMsg>OK</RetMsg>

</Configuration>

GDS37XX HTTP API

P a g e | 15

Version 1.0.0.36

 

2. Door System Basic Settings

Support method: cmd = get / set

Get:

http://<servername>/goform/config?cmd=get&type=door

Example:

<?xml version="1.0"encoding="UTF-8" ?> <Configuration>

<ResCode>0</ResCode> <RetMsg>OK</RetMsg> <P14100>0</P14100> <P14101>5</P14101> <P14829>300</P14829> <P14830>1000</P14830> <P14846>2</P14846> <P14102>5</P14102> <P14103>1</P14103> <P15420>1</P15420> <P15421>1</P15421> <P14105>0</P14105> <P10462/> <P10464>1</P10464> <P10465>0</P10465> <P15423>5</P15423> <P14340>0</P14340> <P14120>0</P14120> <P14121>0</P14121> <P14800>1</P14800> <P14801>1</P14801> <P14856>0</P14856> <P14827>0</P14827>

GDS37XX HTTP API

P a g e | 16

Version 1.0.0.36

 

<P15434>1</P15434> <P10457>88</P10457> <P10463/> <P14850>0</P14850> <P14851/>

<P14852/>

<P14853/> <P14858>0</P14858> <P14560>142000</P14560> <P14561>200059</P14561> <P14562>1</P14562> <P14580>0</P14580> <P15301>0</P15301> </Configuration>

Set:

http://<servername>/goform/config?cmd=set&<parameter>=<value>...

<parameter>=<value>

Model Supported

Values

Description

 

 

 

 

P15440=<int>

GDS3710/GDS3705

<0|1>

Door Relay Options

 

 

 

0:Local Relay

 

 

 

1:Webrelay

 

 

 

 

P15441=<string>

GDS3710/GDS3705

 

Webrelay IP Address

 

 

 

(Max. Length=255)

 

 

 

 

P15442=<string>

GDS3710/GDS3705

 

Webrelay Username

 

 

 

(Max. Length=128)

 

 

 

 

P15443=<string>

GDS3710/GDS3705

 

Webrelay Password

 

 

 

(Max. Length=128)

 

 

 

 

P15450=<int>

GDS3710/GDS3705

<0|1>

ALMOUT1 Feature

 

 

 

0: Alarm Output

 

 

 

1: Open Door

 

 

 

 

P15470=<int>

GDS3710/GDS3705

<0|1>

Lock Status

 

 

 

0: Normal Close

 

 

 

1: Normal Open

 

 

 

 

GDS37XX HTTP API

P a g e | 17

Version 1.0.0.36

 

P15467=<int>

GDS3710/GDS3705

<0|1|2|3>

Control Options

 

 

 

 

 

 

0: Door 1

 

 

 

 

 

 

 

1: Door 2

 

 

 

 

 

 

 

2: Door 1 & Door 2

 

 

 

 

 

 

3: None

 

 

 

 

 

 

 

P15468=<int>

GDS3710/GDS3705

<0|1|2|3>

Wiegand Control Options

 

 

 

 

0: Door 1

 

 

 

 

 

 

 

1: Door 2

 

 

 

 

 

 

 

2: Door 1 & Door 2

 

 

 

 

 

 

3: None

 

 

 

 

 

 

 

P14100=<int>

GDS3710/GDS3705

0 - 20

Delay before Unlock Action(s)

 

 

 

 

P15465=<int>

GDS3710/GDS3705

0 - 20

Door 2 Delay before Unlock(s)

 

 

 

 

P14101=<int>

GDS3710/GDS3705

1 - 1800

Unlock Action Holding Time(s)

 

 

 

 

P15466=<int>

GDS3710/GDS3705

1 - 1800

Door 2 Unlock Holding Time(s)

 

 

 

 

 

 

P14829=<int>

GDS3710/GDS3705

0 - 2000

Minimum

Interval of

Swiping

 

 

 

 

Card

 

 

 

 

 

 

 

(in millisecond)

 

 

 

 

 

 

P15474=<int>

GDS3710

0 – 4 and no

Number of Snapshots when Door

 

 

 

more than

Opened

 

 

 

 

 

 

‘Unlock Action

 

 

 

 

 

 

 

Holding Time’

 

 

 

 

 

 

 

value.

 

 

 

 

 

 

 

 

P15475=<int>

GDS3710

0 – 4 and no

Number of Snapshots when Door

 

 

 

more than

2 Opened

 

 

 

 

 

 

second ‘Door 2

 

 

 

 

 

 

 

Unlock Action

 

 

 

 

 

 

 

Holding Time’

 

 

 

 

 

 

 

value.

 

 

 

 

 

 

 

 

P14103=<int>

GDS3710

<0|1>

Snapshot when Door Opened

 

 

 

 

0: No

 

 

 

 

 

 

 

1: Yes

 

 

 

 

 

 

 

P15471=<int>

GDS3710

<0|1>

Snapshot when Door Opened --

 

 

 

 

via Email:

0: No;

1: Yes

 

 

 

 

 

 

 

 

P15420=<int>

GDS3710

<0|1>

Snapshot when doorbell

 

 

 

 

pressed – via FTP

 

 

 

 

 

 

0: No

 

 

 

 

 

 

 

1: Yes

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

GDS37XX HTTP API

 

P a g e | 18

 

 

 

 

Version 1.0.0.36

 

 

 

 

P15409=<int>

GDS3710

<0|1>

Snapshot when doorbell

 

 

 

 

pressed – via Email

 

 

 

 

0: No

 

 

 

 

1: Yes

 

 

 

 

 

 

P14856=<int>

GDS3710/GDS3705

<0|1>

Call Mode:

 

 

 

 

0: Virtual Number (or

Room

 

 

 

Number)

 

 

 

 

1: SIP Number

 

 

 

 

 

 

P14827=<int>

GDS3710/GDS3705

<0|1|2>

DoorBell Mode:

 

 

 

 

0: Call Doorbell Number

 

 

 

 

1: Doorbell Output Control (DO1)

 

 

 

2: Both above

 

 

 

 

 

P10470=<int>

GDS3710/GDS3705

<0|1|2|3|4>

Doorbell Call Out Account:

 

 

 

0: Auto

 

 

 

 

1: Account 1

 

 

 

 

2: Account 2

 

 

 

 

3: Account 3

 

 

 

 

4: Account 4

 

 

 

 

 

 

P15434=<int>

GDS3710/GDS3705

<0|1>

Door Bell Call Mode:

 

 

 

 

0: Serial Hunting

 

 

 

 

1: Parallel Hunting

 

 

 

 

 

P10462=<string>

GDS3710/GDS3705

 

Number Called When Door Bell

 

 

 

Pressed (Max. Length=255)

 

 

 

 

 

P15418=<int>

GDS3710/GDS3705

0--10

Press Doorbell Schedule

 

 

 

 

 

 

P15419=<int>

GDS3710/GDS3705

0--20

Maximum Number of

Dialed

 

 

 

Digits

 

 

 

 

 

 

P15436=<int>

GDS3710/GDS3705

1 - 15

No Key Input Timeout(s)

 

 

 

 

 

 

P10457=<string>

GDS3710/GDS3705

 

Remote PIN to Open Door

 

 

 

Max. length = 8

 

 

 

 

 

 

P15460=<string>

GDS3710/GDS3705

 

Remote PIN to Open Door 2.

 

 

 

Max. length = 8

 

 

 

 

 

P10464=<int>

GDS3710/GDS3705

<0|1|2>

PIN type for Open Door locally:

 

 

 

0: Private PIN

 

 

 

 

1 Unified PIN

 

 

 

 

2 Card & private PIN

 

 

 

 

 

 

GDS37XX HTTP API

P a g e | 19

Version 1.0.0.36

 

P10463=<string>

GDS3710/GDS3705

 

Local PIN to Open Door

 

 

 

 

(all digit value)

 

 

 

 

P14858=<int>

GDS3710/GDS3705

<0|1>

Enable DTMF Open Door

 

 

 

 

0: Enable

 

 

 

 

1: Disable (Default)

 

 

 

 

P14825=<int>

GDS3710/GDS3705

<0|1>

Enable Guest PIN Open Door:

 

 

 

 

0: Disable

 

 

 

 

1: Enable

 

 

 

 

P14851=<string>

GDS3710/GDS3705

 

Guest PIN:

 

 

 

 

Numerical Digits

 

 

 

 

Max. Length = 8

 

 

 

 

P14852=<string>

GDS3710/GDS3705

e.g.: 2017/06/14

Guest PIN starting time

 

 

 

00:00:00

 

 

 

 

 

 

P14853=<string>

GDS3710/GDS3705

e.g.: 2017/06/14

Guest PIN ending time

 

 

 

02:02:10

 

 

 

 

 

 

 

 

 

GDS3710/GDS3705

 

Disable Auto-Answer

P14580=<int>

 

<0|1>

0: Disable (Default)

 

 

 

 

1: Enable

 

 

 

 

P14582=<int>

GDS3710/GDS3705

<0|1>

Enable Doorbell Button to Hang

 

 

 

 

Up Call

 

 

 

 

0: Disable (Default)

 

 

 

 

1: Enable

 

 

 

 

P15421=<int>

GDS3710/GDS3705

<0|1>

Disable Keypad (except Doorbell

 

 

 

 

Button)

 

 

 

 

0: Disable (Default)

 

 

 

 

1: Enable

 

 

 

 

P15422=<int>

GDS3710/GDS3705

<0|1>

Enable On Hook After Remote

 

 

 

 

Door Opened

 

 

 

 

0: Disable (Default)

 

 

 

 

1: Enable

 

 

 

 

P15424=<int>

GDS3710/GDS3705

<0|1>

Enable HTTP API Remote Open

 

 

 

 

Door

 

 

 

 

0: Disable (Default)

 

 

 

 

1: Enable

 

 

 

 

P15433=<int>

GDS3710/GDS3705

<0|1>

Disable Keypad SIP Number

 

 

 

 

Dialing

 

 

 

 

0: Disable (Default);

 

 

 

 

1: Enable

 

 

 

 

 

 

 

 

 

 

 

 

 

GDS37XX HTTP API

P a g e | 20

 

 

Version 1.0.0.36

 

 

P15543=<int>

GDS3710/GDS3705

<0|1>

One-way Interlocking Doors

 

 

 

Mode

 

 

 

 

 

 

0: Disable (Default);

 

 

 

 

1: Enable

 

 

 

 

 

 

 

P15428=<int>

GDS3710/GDS3705

5 -- 300

Open Door Valid Time

 

 

 

 

 

 

 

 

P10465=<int>

GDS3710/GDS3705

<0|1>

Enable Card Issuing Mode

 

 

 

0: Disable (Default)

 

 

 

 

1: Enable

 

 

 

 

 

 

 

 

 

P15423=<int>

GDS3710/GDS3705

1-1440

Card

Issuing

State

Expire

 

 

 

Time(m)

 

 

 

 

 

 

 

P14800=<int>

GDS3710/GDS3705

<0|1>

Enable Key Blue Light

 

 

 

 

0: Disable

 

 

 

 

 

1: Enable

 

 

 

 

 

 

P14801=<int>

GDS3710

<0|1>

Enable White LED Back Light

 

 

 

0: Disable

 

 

 

 

 

1: Enable

 

 

 

 

 

 

 

 

P15301=<int>

GDS3710/GDS3705

 

Central Mode

 

 

 

 

<0|1>

0: Disable (Default)

 

 

 

 

1: Enable

 

 

 

 

 

 

 

P15544=<int>

GDS3710/GDS3705

<0|1>

Key Sensitivity Level

 

 

 

 

0: Default

 

 

 

 

 

1: High

 

 

 

 

 

 

 

P14340=<int>

GDS3710/GDS3705

<0|1|2>

Key Pressing Tone

 

 

 

 

0: Default

 

 

 

 

 

1: DTMF

 

 

 

 

 

2: Mute

 

 

 

 

 

 

 

P14120=<int>

GDS3710/GDS3705

<0|1>

Enable Weigand Input

 

 

 

 

0 Disable

 

 

 

 

 

1 Enable

 

 

 

 

 

 

 

 

P14121=<int>

GDS3710/GDS3705

<0|1|2>

Weigand Output

 

 

 

 

 

0 Disable

 

 

 

 

 

1:

Relay

and

Local

 

 

 

Authentication

 

 

 

 

 

2: Relay and Bypass Local

 

 

 

 

 

 

 

GDS37XX HTTP API

P a g e | 21

Version 1.0.0.36

 

P14560=<string>

GDS3710/GDS3705

 

Start time turning on the Blue

 

 

 

Door Bell Light

 

 

 

Digit string like “1459”. The first

 

 

 

two digit is 24-hour format, last

 

 

 

two is minutes

 

 

 

00 <= hour <=23;

 

 

 

00 <= minute <= 59

 

 

 

 

P14561=<string>

GDS3710/GDS3705

 

End time turning on the Blue

 

 

 

Door Bell Light

 

 

 

Digit string like “1459”. The first

 

 

 

two digit is 24-hour format, las

 

 

 

two is minutes

 

 

 

00 <= hour <=23

 

 

 

00 <= minute <= 59

 

 

 

 

P14562=<int>

GDS3710/GDS3705

<0|1>

Enable Door Bell Blue Light

 

 

 

0 Disable

 

 

 

1 Enable

 

 

 

 

P15514

GDS3710/GDS3705

<0|1>

System_Settings.Access_Settin

 

 

 

gs.Enable_PIN_Password_Displ

 

 

 

ay_HTTPS

 

 

 

0: Disable;

 

 

 

1: Enable.

 

 

 

 

P15514

GET:[http|https]://<servername>/goform/config?cmd=get&type=access

SET:[http|https]://<servername>/goform/config?cmd=set&P15514=<value>

P15440/ P15441/ P15442/ P15443

GET:[http|https]://<servername>/goform/config?cmd=get&type=door

SET:[http|https]://<servername>/goform/config?cmd=set&Pxxx=<value>

3. Keep Door Open

Supported Devices: GDS3710/GDS3705

Support method: cmd = get / set

GDS37XX HTTP API

P a g e | 22

Version 1.0.0.36

 

Get:

http://<servername>/goform/config?cmd=get&type=sch_open_door

Example:

<?xml version="1.0"encoding="UTF-8" ?> <Configuration>

<ResCode>0</ResCode> <RetMsg>OK</RetMsg> <P14042>14</P14042> <P14043>4</P14043> <P14044>7</P14044> <P15429>2</P15429> <P15430>5</P15430> <P15211>20180514000000</P15211> <P15212>20180522000000</P15212>

<P15213>door sch,0@0000@2359</P15213> </Configuration>

Set:

http://<servername>/goform/config?cmd=set&<parameter>=<value>...

<parameter>=<value>

Model Supported

Values

 

Description

 

 

 

 

 

P15429=<int>

GDS3710/GDS3705

0 - 2

Keep Door Open

 

 

 

0: Disable

1: Immediate Open

 

 

 

Door

 

 

 

 

2: Schedule Open Door

 

 

 

 

P15435=<digital string>

GDS3710/GDS3705

 

Emergency PIN to Disable Keep

 

 

 

Door Open

 

 

 

 

 

P15430=<int>

GDS3710/GDS3705

5 - 480

Length(m) to Keep Door Open

 

 

 

 

P15211=<digital string>

GDS3710/GDS3705

 

Schedule Start Time

 

 

 

 

 

P15212=<digital string>

GDS3710/GDS3705

 

Schedule End Time

 

 

 

 

 

P15506=<int>

GDS3710

 

Holiday Mode

 

 

 

0: Disabled

 

 

 

 

1-10: Holiday1-10

 

 

 

 

 

GDS37XX HTTP API

P a g e | 23

Version 1.0.0.36

 

P15213=<string>

GDS3710/GDS3705

 

Schedule Table

 

 

 

Format:

 

 

 

 

door_sch,index@start_time@end_

 

 

 

time

 

 

 

 

Example:

 

 

 

 

P15213=door_sch,0@0000@2359

 

 

 

 

P15455=<int>

GDS3710/GDS3705

0 - 2

Keep Door Open

 

 

 

0: Disable

1: Immediate Open

 

 

 

Door

 

 

 

 

2: Schedule Open Door

 

 

 

 

P15435=<digital string>

GDS3710/GDS3705

 

Emergency PIN to Disable Keep

 

 

 

Door Open (Door 2)

 

 

 

 

P15456=<int>

GDS3710/GDS3705

5 - 480

Length(m) to Keep Door Open

 

 

 

(Door 2)

 

 

 

 

 

P15457=<digital string>

GDS3710/GDS3705

 

Schedule Start Time (Door 2)

 

 

 

 

 

P15458=<digital string>

GDS3710/GDS3705

 

Schedule End Time (Door 2)

 

 

 

 

 

P15507=<int>

GDS3710

 

Holiday Mode (Door 2)

 

 

 

0: Disabled

 

 

 

 

1-10: Holiday1-10

 

 

 

 

P15459=<string>

GDS3710/GDS3705

 

Schedule Table (Door 2)

 

 

 

Format:

 

 

 

 

door_sch,index@start_time@end_

 

 

 

time

 

 

 

 

Example:

 

 

 

 

P15459=door_sch,0@0000@2359

 

 

 

 

 

4. Group

Supported Devices: GDS3710/GDS3705

Support M ethods: cmd = get/add/set/del

Get:

http://<servername>/goform/config?cmd=get&type=group

Example:

GDS37XX HTTP API

P a g e | 24

Version 1.0.0.36

 

<?xml version="1.0"encoding="UTF-8" ?> <Configuration>

<ResCode>0</ResCode> <RetMsg>OK</RetMsg> <group>

<groupid>1</groupid> <schid>0</schid> <groupName>Qua</groupName>

</group>

<group> <groupid>2</groupid> <schid>1</schid>

<groupName>Tech</groupName> </group>

<P15301>0</P15301> <schdeulelist>

<schdeuleitem>AAA@0,</schdeuleitem> <schdeuleitem>BBB@0,</schdeuleitem> <schdeuleitem>schedule3@0,0@0000@0000,</schdeuleitem> <schdeuleitem>schedule4@0,0@0000@0000,</schdeuleitem> <schdeuleitem>schedule5@0,0@0000@0000,</schdeuleitem> <schdeuleitem>schedule6@0,0@0000@0000,</schdeuleitem> <schdeuleitem>schedule7@0,0@0000@0000,</schdeuleitem> <schdeuleitem>schedule8@0,0@0000@0000,</schdeuleitem> <schdeuleitem>schedule9@0,0@0000@0000,</schdeuleitem> <schdeuleitem>schedule10@0,0@0000@0000,</schdeuleitem>

</schdeulelist>

</Configuration>

Add:

http://<servername>/goform/config?cmd=add&<para1>=<value1>&<para2>=<value2>

<para>=<value>

Values

Description

 

 

 

groupname=<string>&schid=<int>

groupname:

groupname Max. Length=64

 

string

 

 

 

 

 

schid: 1 -- 10

Time Schedule Index

 

 

 

GDS37XX HTTP API

P a g e | 25

Version 1.0.0.36

 

Set:

http://<servername>/goform/config?cmd=set&<para1>=<value1>&<para2>=<value2>&<p

ara3>=<value3>

<parameter>=<value>

Values

Description

 

 

 

<para1>=<value1>&<para2>=<value2>&

groupid: 1-10

groupname Max. Length=64

<para3>=<value3>

 

schid: Time Schedule Index

groupid=<int>&groupname=<string>&sc

schid: 1-10

groupid: group index.

hid=<int>

 

 

 

 

 

Del:

http://<servername>/goform/config?cmd=del&<para1>=<value1>

 

 

 

 

 

 

 

 

<parameter>=<value>

Values

Description

 

 

 

 

 

groupid=<int>

1 - 10

groupid: group index.

 

 

 

 

 

GDS37XX HTTP API

P a g e | 26

Version 1.0.0.36

 

5. Schedule

Supported Devices: GDS3710/GDS3705

Support M ethods: cmd = get / set

Get:

http://<servername>/goform/config?cmd=get&type=door_schedule

Example:

<?xml version="1.0"encoding="UTF-8" ?> <Configuration>

<ResCode>0</ResCode> <RetMsg>OK</RetMsg> <P15301>0</P15301> <P15200>AAA@0,</P15200> <P15201>BBB@0,</P15201>

<P15202>schedule3@0,0@0000@0000,</P15202> <P15203>schedule4@0,0@0000@0000,</P15203> <P15204>schedule5@0,0@0000@0000,</P15204> <P15205>schedule6@0,0@0000@0000,</P15205> <P15206>schedule7@0,0@0000@0000,</P15206> <P15207>schedule8@0,0@0000@0000,</P15207> <P15208>schedule9@0,0@0000@0000,</P15208> <P15209>schedule10@0,0@0000@0000,</P15209> <holidayitem>holiday1,</holidayitem> <holidayitem>holiday2,</holidayitem> <holidayitem>holiday3,</holidayitem> <holidayitem>holiday4,</holidayitem> <holidayitem>holiday5,</holidayitem> <holidayitem>holiday6,</holidayitem> <holidayitem>holiday7,</holidayitem> <holidayitem>holiday8,</holidayitem> <holidayitem>holiday9,</holidayitem> <holidayitem>holiday10,</holidayitem>

</Configuration>

GDS37XX HTTP API

P a g e | 27

Version 1.0.0.36

 

Set:

http://<servername>/goform/config?cmd=set&<paramter>=<value>...

 

<parameter>=<value>

 

Model Supported

 

Value

Description

 

 

 

 

 

 

 

 

 

 

P15200=<string>

 

 

 

 

Value format:

 

 

P15201=<string>

 

 

 

 

name@holiday_mode,weekday0@start_time0@end_ti

 

 

 

 

 

 

me0,weekday1@start_time1@end_time1,...

 

 

 

 

 

 

 

 

 

P15202=<string>

 

 

 

 

Use (,) as separator when set multiple numbers.

 

 

P15203=<string>

 

 

 

 

 

 

 

 

 

 

e.g.:

 

 

P15204=<string>

 

 

 

 

 

 

P15205=<string>

 

GDS3710/GDS3705

 

 

AAA@0,0@0830 @1459 ,0@1600@1800,

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

P15206=<string>

 

 

 

 

AAA is a revisable name for a schedule, Max. Length =

 

 

P15207=<string>

 

 

 

 

64

 

 

 

 

 

 

1st @ represent holiday mode, 0-10.

 

 

P15208=<string>

 

 

 

 

 

 

P15209=<string>

 

 

 

 

2st @ represent date of the week, 0-6, Sunday to

 

 

 

 

 

 

Saturday

 

 

 

 

 

 

 

 

 

 

 

 

 

 

3nd @ the pre-four digits represent start time of that

 

 

 

 

 

 

 

period, 0830 represent 08:30 in 24 hour format;

 

 

 

 

 

 

 

2nd @ the post-four digits represent end time of that

 

 

 

 

 

 

 

period, 1459 represent 14:59 in 24 hour format.

 

 

 

 

 

 

 

 

 

Notes:

There should be NO overlap in any time period configured in the same day.

(,) should be used to separate the different time period configured.

GDS37XX HTTP API

P a g e | 28

Version 1.0.0.36

 

6. Holiday

Supported Devices: GDS3710/GDS3705

Supported Methods: cmd = get/set

Get:

http://<servername>/goform/config?cmd=get&type=holiday

Example

<?xml version="1.0"encoding="UTF-8" ?> <Configuration>

<ResCode>0</ResCode> <RetMsg>OK</RetMsg> <P15301>0</P15301>

<P15250>schedule_1,</P15250> <P15251>schedule_2,</P15251> <P15252>schedule_3,</P15252> <P15253>schedule_4,</P15253> <P15254>schedule_5,</P15254> <P15255>schedule_6,</P15255> <P15256>schedule_7,</P15256> <P15257>schedule_8,</P15257> <P15258>schedule_9,</P15258> <P15259>schedule_10,</P15259>

</Configuration>

Set:

http://<servername>/goform/config?cmd=set&<parameter>=<value>...

 

<parameter>=<value>

 

Model

 

Value

 

Description

 

 

 

 

 

Supported

 

 

 

 

 

 

P15250=<string>

 

 

 

 

Value format:

 

 

 

 

P15251=<string>

 

GDS3710/

 

 

name,start_date0@end_date0,

 

 

 

 

 

 

start_date1@end_date1,

 

 

 

 

 

 

 

 

 

 

 

P15252=<string>

 

GDS3705

 

 

 

 

 

 

 

P15253=<string>

 

 

 

 

Use (,) as separator when set multiple

 

 

 

 

 

 

 

dates.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

GDS37XX HTTP API

P a g e | 29

 

 

 

 

Version 1.0.0.36

 

 

 

 

P15254=<string>

 

 

 

 

 

 

P15255=<string>

 

GDS3710/

 

e.g.:

 

 

 

 

schedule_1,20180405@20180420,

 

 

 

 

 

 

 

 

P15256=<string>

 

GDS3705

 

20180421@20180425,

 

 

P15257=<string>

 

 

 

schedule_1is a revisable name for a

 

 

 

 

 

schedule, Max. Length = 64

 

 

 

 

 

 

 

 

P15258=<string>

 

 

 

 

 

 

P15259=<string>

 

 

 

 

 

 

 

 

 

 

 

 

There should be NO overlap in any time period configured in the same day.

(,) should be used to separate the different time period configured.

GDS37XX HTTP API

P a g e | 30

Version 1.0.0.36

 

Loading...
+ 92 hidden pages