Get Alarm Group List

  • Description

    This interface is used to retrieve a list of alarm groups.

  • Request URLs

    URL:[Host Server]/api/v2/alarm/group/get

  • Address Parameters Description

    Field Type Description
    Host Server string See Explanation of terms

  • Method

    POST

  • Headers

    Field Type Description
    Authorization string "Bearer " + Access Token obtained from the login interface

  • Body

    Field Type Description
    boxId long ID of the FGate

  • Successful Response
    Returns a list of all alarm groups, each group represented as a jsonObject

    Field Type Description
    uid long Alarm group UID
    name string Name of the alarm group
    contactList list Collection of alarm contact names
    memo string Remark
    contacts list Attributes of individual contacts, see table below

    Attributes of one contact in contact list:

    Field Type Description
    uid long Alarm contact ID
    name string Alarm contact name
    cellphone string Alarm contact phone number
    noticeType int 1: SMS, 2: Voice, 3: SMS & Voice
    email string Alarm contact email
    enable bool Whether enabled
    memo string Remark

  • Return Codes

    Field Description
    401 Access token has expired
    404 The interface does not exist, please check the URL
    400 Error message in HTTP Header [X-FBox-Code],see Appendix Three for details