Create SIP endpoint

This endpoint allows you to create new SIP endpoint. Creation parameters are passed in body, look for specification below. If userpass authentication method is chosen and password is not provided, there will be generated password in response. Make sure to store it.

Header Parameters

Authorization*string

Your API token

Request Body

application/json

SIP endpoint creation parameters

auth?string

Authentication method for this SIP endpoint. It is recommended to use ip and userpass, and avoid combined, as its functionality is not fully developed.

Value in"ip" | "userpass" | "combined"

description?string

The description of the SIP endpoint.

ip_acl?string

If you pass auth=ip, you must also pass ip_acl parameter. It accepts a valid IPv4 address. If auth=userpass, this value will be ignored.

name?string

The name of the SIP endpoint.

password?string

Optional parameter. If you pass auth=userpass, you can either pass your own password, or let it be generated automatically. In the second case, you will see generated password in the response. It will be shown only once, so be sure to store it.

username?string

If you pass auth=userpass, you must also pass username parameter. It accepts a string between 3 and 64 characters. Username must be unique across system, so if provided username is already in use, you will receive a 400 Bad Request response. If you pass auth=ip, this value will be ignored.

Response Body

`application/json`

curl -X POST "https://dev-refactor-api-e.voipenv.uk/api/v1/sip/endpoints" \  -H "Authorization: string" \  -H "Content-Type: application/json" \  -d '{}'

{
  "endpoint": {
    "auth": "ip",
    "created_at": "string",
    "description": "string",
    "disabled_at": "string",
    "id": 0,
    "ip_acl": "string",
    "is_active": true,
    "name": "string",
    "username": "string"
  },
  "password": "string"
}

{
  "code": 0,
  "error_details": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  },
  "message": "string",
  "request_id": "string",
  "status": "error"
}

{
  "code": 0,
  "error_details": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  },
  "message": "string",
  "request_id": "string",
  "status": "error"
}

{
  "code": 0,
  "error_details": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  },
  "message": "string",
  "request_id": "string",
  "status": "error"
}

Create SIP endpoint

Header Parameters

Request Body

Response Body

200application/json

400application/json

403application/json

500application/json

Contact us

`application/json`

`application/json`

`application/json`

`application/json`