Get Alarm Contact List

  • Description

    This API is used to retrieve a list of alarm contacts .

  • Request URLs

    URL:[Host Server]/api/v2/contacts

  • Address Parameters Description

    Field Type Description
    Host Server string See Explanation of terms

  • Request

    GET

  • Headers

    Field Type Description
    Authorization string "Bearer " + Access Token obtained from the login interface
    X-FBox-ClientId string Refer to Appendix One

  • Body

    NULL

  • Successful Response

    Returns a jsonObject array of alarm contacts

    Field Type Description
    uid string Alarm contact UID
    email string Email of alarm contact
    name string Name of alarm contact
    cellphone string Phone number of alarm contact
    enabled Boolean Whether the contact is enabled
    noticeType int 0: None, 1: SMS, 2: Voice, 3: SMS and Voice
    memo string Remark

  • Return Codes

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