3.5.10.2 SIP

Getting list of SIP devices

URL:

https://{{ip_addr}}/api/v1/hipmo/devices/sip

HTTP method:

GET

Response code:

Standard HTTP response code, treating syntactic errors.

Response data:

{
    "data": {
        "devices": []
    }
}

Create SIP device

URL:

https://{{ip_addr}}/api/v1/hipmo/devices/sip

HTTP method:

PUT

Response code:

Standard HTTP response code, treating syntactic errors.

Request body:
{
    "id": "<integer>",
    "name": "<string>",
    "isActive": "<boolean>",
    "isMy2n": "<boolean>",
    "sipLine": "<string>",
    "dtmf1": "<string>",
    "dtmf2": "<string>",
    "dtmf3": "<string>",
    "dtmf4": "<string>"
}

Response data:

{ 
   "data":{ 
      "devices":[ 
         "device":         { 
            "id":"<integer>",
            "name":"<string>",
            "isActive":"<boolean>",
            "isMy2n":"<boolean>",
            "sipLine":"<string>",
            "dtmf1":"<string>",
            "dtmf2":"<string>",
            "dtmf3":"<string>",
            "dtmf4":"<string>"
         }
      ]
   }
}

 


SIP device update 

URL:

https://{{ip_addr}}/api/v1/hipmo/devices/sip/{{id}}

HTTP method:

PUT

Path variable:id – device ID
Request body:
{
    "id": "<integer>",
    "name": "<string>",
    "isActive": "<boolean>",
    "isMy2n": "<boolean>",
    "sipLine": "<string>",
    "dtmf1": "<string>",
    "dtmf2": "<string>",
    "dtmf3": "<string>",
    "dtmf4": "<string>"
}

Response code:

Standard HTTP response code, treating syntactic errors.

Response data:

{ 
   "data":{ 
      "devices":[ 
         "device":         { 
            "id":"<integer>",
            "name":"<string>",
            "isActive":"<boolean>",
            "isMy2n":"<boolean>",
            "sipLine":"<string>",
            "dtmf1":"<string>",
            "dtmf2":"<string>",
            "dtmf3":"<string>",
            "dtmf4":"<string>"
         }
      ]
   }
}

Delete device

URL:

https://{{ip_addr}}/api/v1//hipmo/devices/sip/{{id}}

HTTP method:

DELETE

Path variable:id – device ID

Response code:

Standard HTTP response code, treating syntactic errors.

Request body:
{
    "id": "<integer>",
    "name": "<string>",
    "isActive": "<boolean>",
    "isMy2n": "<boolean>",
    "sipLine": "<string>",
    "dtmf1": "<string>",
    "dtmf2": "<string>",
    "dtmf3": "<string>",
    "dtmf4": "<string>"
}