Get device SIP settings

Get device SIP settings

Responses

• 200
• 401

---

OK

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• proxy ipv4|dns

  SIP proxy address

• realm ipv4|dns

  SIP server address

• user string

  Possible values: non-empty and <= 31 characters

  User number

• password string

  Possible values: non-empty and <= 31 characters

  Password used for authentication on SIP server

• stun object

  STUN server settings

  ip ipv4|dns

  STUN server address

  port integer

  STUN server port

• registration_interval number

  Possible values: >= 30 and <= 900

  For what period of time device stays registered on SIP server, re-registration happens 6 seconds before expiration time

• h264 integer

  Possible values: >= 99 and <= 127

  Default value: 102

  h.264 payload type

• transport string

  Possible values: [udp, tcp, tls]

  Which protocol should be used

{
  "proxy": "sip:sip.bas-ip.com",
  "realm": "sip.bas-ip.com",
  "user": "101",
  "password": "123abc",
  "stun": {
    "ip": "stun.l.google.com",
    "port": 19302
  },
  "registration_interval": 50,
  "h264": 102,
  "transport": "udp"
}

{
  "proxy": "sip:sip.bas-ip.com",
  "realm": "sip.bas-ip.com",
  "user": "101",
  "password": "123abc",
  "stun": {
    "ip": "stun.l.google.com",
    "port": 19302
  },
  "h264": 102,
  "transport": "udp",
  "registration_interval": 50
}

Please log in

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• error object

  Describes the base error user might get

  code string

  Possible values: [invalid_authentication, permission_denied, not_valid, system_error]

  Error code

  message string

  Error message

  data object

  Did not pass validation parameters. Can be represented as an object, which can include field names, arrays, query parameters etc.

  param string

  Describes the parameter that did not pass a validation

{
  "error": {
    "code": "not_valid",
    "message": "Data validation error",
    "data": {
      "param": "must be a string"
    }
  }
}

{
  "error": {
    "code": "invalid_authentication",
    "message": "Log In"
  }
}

Loading...