Auto Provisioning | PortSIP Knowledge Base

List firmware templates

get

List IP phones template files

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

get

/templates/phones

GET /api/templates/phones HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "filename": null,
      "is_custom": null
    }
  ]
}

Create a new firmware template

post

Create a new firmware template into system.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

filenamestringOptional

Template XML file name for phone provisioning.

contentstringOptional

The file content of the template.

Responses

201

Created

application/json

4XX

Error

post

/templates/phones

POST /api/templates/phones HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "filename": null,
  "content": null
}

{
  "id": "xxxxxxxx"
}

Retrieve details of firmware template

get

Retrieve details of template file by it's filename.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

filenamestringRequired

Template XML file name for phone provisioning.

Responses

200

OK

application/json

4XX

Error

get

/templates/phones/{filename}

GET /api/templates/phones/{filename} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "filename": null,
  "content": null,
  "is_custom": null
}

Update firmware template

post

Update phone template.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

filenamestringRequired

Template XML file name for phone provisioning.

Body

contentstringOptional

The file content of the template.

Responses

200

OK

No content

4XX

Error

post

/templates/phones/{filename}

POST /api/templates/phones/{filename} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "content": null
}

No content

Remove an firmware template

post

Remove custom template by it's filename.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

filenamestringRequired

Template XML file name for phone provisioning.

Responses

204

No Content

4XX

Error

post

/templates/phones/{filename}/destroy

POST /api/templates/phones/{filename}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List phone models

get

List IP phones models.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

get

/phone_models

GET /api/phone_models HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "filename": null,
      "model": null,
      "display_name": null
    }
  ]
}

Retrieve profile of firmware template

get

Retrieve phone template profile by it's filename.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

filenamestringRequired

Template XML file name for phone provisioning.

Responses

200

OK

application/json

4XX

Error

get

/phone_models/{filename}

GET /api/phone_models/{filename} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "filename": null,
  "languages": null,
  "ringtones": null,
  "queue_ringtones": null,
  "external_ringtone": null,
  "date_formats": null,
  "time_formats": null,
  "powerleds": null,
  "backlights": null,
  "screensavers": null,
  "time_zones": null,
  "codecs": null,
  "enable_lldp": null,
  "enable_vlan_wan_port": null,
  "wan_port_id": null,
  "wan_port_priority": null,
  "enable_vlan_pc_port": null,
  "pc_port_id": null,
  "pc_port_priority": null
}

List IP phones

get

List IP phones

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

get

/phones

GET /api/phones HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "extension_number": null,
      "vendor": null,
      "model": null,
      "fwver": null,
      "name": null,
      "password": null,
      "vm_pin": null,
      "ip": null,
      "mac": null
    }
  ]
}

Reprovision all phones

post

Re-provision all phones.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

No content

4XX

Error

post

/phones/reprovision

POST /api/phones/reprovision HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Retrieve Phone's detailed information.

get

Retrieve phone's detailed information.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

macstringRequired

MAC address.

Responses

200

OK

application/json

404

Not Found

get

/phones/{mac}

GET /api/phones/{mac} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "extension_number": null,
  "vendor": null,
  "model": null,
  "fwver": null,
  "name": null,
  "password": null,
  "vm_pin": null,
  "ip": null,
  "mac": null
}

Check phone's assignee

get

Check phone's assignee by MAC.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

macstringRequired

MAC address.

Responses

200

OK

application/json

404

Not Found

get

/phones/{mac}/assignee

GET /api/phones/{mac}/assignee HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "mac": null,
  "extension_number": null,
  "vendor": null,
  "model": null
}

Reprovision a phone

post

Re-provision a phone by it's MAC address.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

macstringRequired

MAC address.

Responses

200

OK

No content

4XX

Error

post

/phones/{mac}/reprovision

POST /api/phones/{mac}/reprovision HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Reboot Phone

post

Reboot Phone

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

macstringRequired

MAC address.

Responses

200

OK

No content

4XX

Error

post

/phones/{mac}/reboot

POST /api/phones/{mac}/reboot HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Reject a phone

post

Reject a phone from auto provisioning.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

macstringRequired

MAC address.

Responses

200

OK

No content

400

Invalid mac address.

post

/phones/{mac}/reject

POST /api/phones/{mac}/reject HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List DECT phone models

get

List DECT phone models.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

get

/dect_phone_models

GET /api/dect_phone_models HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "filename": null,
      "model": null,
      "lines": null,
      "display_name": null
    }
  ]
}

Retrieve details of DECT phone model

get

Retrieve details of DECT phone model.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

namestringRequired

Template XML file name for phone provisioning.

Responses

200

OK

application/json

4XX

Error

get

/dect_phone_models/{name}

GET /api/dect_phone_models/{name} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "template": null,
  "languages": null,
  "tones": null,
  "time_zones": null,
  "codecs": null,
  "lines": null
}

List DECT phones

get

List DECT phones

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

get

/dect_phones

GET /api/dect_phones HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": null,
      "name": null,
      "mac": null,
      "template": null,
      "vendor": null,
      "model": null,
      "password": null,
      "user_password": null,
      "engineer_password": null,
      "timezone": null,
      "region": null,
      "language": null,
      "handset_language": null,
      "tone": null,
      "rps": null,
      "https": null,
      "codecs": null,
      "lines": null,
      "interface": null,
      "preferred_transport": null,
      "url": null
    }
  ]
}

Create a DECT phone

post

Create a DECT phone.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

namestring · min: 1 · max: 64Required

The name of DECT phone.

macall ofRequired

MAC address of this IP phone.

stringOptional

MAC address.

templatestringRequired

Template XML file name for phone provisioning.

vendorstringRequired

The phone vendor of IP phone.

modelstringRequired

The name of IP phone model.

passwordstringRequired

Password for accessing the Web interface of phone. The username remains default because most phone manufacturers do not allow modification of the user name. This is supported for some phone model, such as "Snom 300".

user_passwordstringOptional

The user password.

engineer_passwordstringOptional

The engineer password.

timezonestringRequired

The timezone of phone.

regionstringOptional

The country or region name of phone.

languagestring · enumRequired

Language for strings displayed on Phone Display LCD. Supported languages include ENGLISH, CHINESE, DUTCH, FRENCH, GERMAN, GREEK, ITALIAN, JAPANESE, POLISH, RUSSIAN, SPANISH, SWEDISH, UKRAINIAN, and BULGARIAN.

Possible values:

handset_languagestring · enumOptional

The handset language.

Possible values:

tonestringRequired

The tone set of DECT phone.

rpsbooleanOptional

Send to RPS or not.

httpsbooleanOptional

Whether to use https

codecsstring[]Required

The list of currently enabled codec formats.

interfacestring · enumRequired

The interface type for QR code or auto provisioning.
Can be neither:

WEB_DOMAIN:
PUBLIC_IPV4:
PUBLIC_IPV6:
PRIVATE_IPV4:
PRIVATE_IPV6:
SBC_DOMAIN:

Possible values:

preferred_transportstring · enumRequired

The transport protocol:
Can be either:

UDP:
TCP:
TLS:

Possible values:

Responses

201

Created

application/json

4XX

Error

post

/dect_phones

POST /api/dect_phones HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 293

{
  "name": null,
  "mac": null,
  "template": null,
  "vendor": null,
  "model": null,
  "password": null,
  "user_password": null,
  "engineer_password": null,
  "timezone": null,
  "region": null,
  "language": null,
  "handset_language": null,
  "tone": null,
  "rps": null,
  "https": null,
  "codecs": null,
  "interface": null,
  "preferred_transport": null
}

{
  "id": "xxxxxxxx"
}

Retrieve DECT Phone's detailed information.

get

Retrieve DECT phone's detailed information.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of DECT phone.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

404

Not Found

get

/dect_phones/{id}

GET /api/dect_phones/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": null,
  "name": null,
  "mac": null,
  "template": null,
  "vendor": null,
  "model": null,
  "password": null,
  "user_password": null,
  "engineer_password": null,
  "timezone": null,
  "region": null,
  "language": null,
  "handset_language": null,
  "tone": null,
  "rps": null,
  "https": null,
  "codecs": null,
  "lines": null,
  "interface": null,
  "preferred_transport": null,
  "url": null
}

Update DECT phone

post

Update a DECT phone.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of DECT phone.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

namestring · min: 1 · max: 64Optional

The name of DECT phone.

passwordstringOptional

Password for accessing the Web interface of phone. The username remains default because most phone manufacturers do not allow modification of the user name. This is supported for some phone model, such as "Snom 300".

user_passwordstringOptional

The user password.

engineer_passwordstringOptional

The engineer password.

timezonestringOptional

The timezone of phone.

regionstringOptional

The country or region name of phone.

languagestring · enumOptional

Language for strings displayed on Phone Display LCD. Supported languages include ENGLISH, CHINESE, DUTCH, FRENCH, GERMAN, GREEK, ITALIAN, JAPANESE, POLISH, RUSSIAN, SPANISH, SWEDISH, UKRAINIAN, and BULGARIAN.

Possible values:

handset_languagestring · enumOptional

The handset language.

Possible values:

tonestringOptional

The tone set of DECT phone.

rpsbooleanOptional

Send to RPS or not.

httpsbooleanOptional

Whether to use https

codecsstring[]Optional

The list of currently enabled codec formats.

interfacestring · enumOptional

The interface type for QR code or auto provisioning.
Can be neither:

WEB_DOMAIN:
PUBLIC_IPV4:
PUBLIC_IPV6:
PRIVATE_IPV4:
PRIVATE_IPV6:
SBC_DOMAIN:

Possible values:

preferred_transportstring · enumOptional

The transport protocol:
Can be either:

UDP:
TCP:
TLS:

Possible values:

Responses

200

OK

No content

4XX

Error

post

/dect_phones/{id}

POST /api/dect_phones/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 239

{
  "name": null,
  "password": null,
  "user_password": null,
  "engineer_password": null,
  "timezone": null,
  "region": null,
  "language": null,
  "handset_language": null,
  "tone": null,
  "rps": null,
  "https": null,
  "codecs": null,
  "interface": null,
  "preferred_transport": null
}

No content

Delete a DECT phone

post

Delete a DECT phone by it's ID.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of DECT phone.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

4XX

Error

post

/dect_phones/{id}/destroy

POST /api/dect_phones/{id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List DECT phone members

get

Retrieve a collection of DECT phone members.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of DECT phone.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

4XX

Error

get

/dect_phones/{id}/members

GET /api/dect_phones/{id}/members HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": null,
      "extension_number": null,
      "display_name": null,
      "ipui": null,
      "handset_index": null
    }
  ]
}

Update DECT phone member list

post

Update DECT phone member list.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of DECT phone.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

Responses

200

OK

No content

4XX

Error

post

/dect_phones/{id}/members

POST /api/dect_phones/{id}/members HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 70

{
  "items": [
    {
      "extension_number": null,
      "ipui": null,
      "handset_index": null
    }
  ]
}

No content

Check DECT phone member

get

Check if extension is in DECT phone member list.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of DECT phone.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

extension_numberstring · min: 3 · max: 64Required

The extension number.

Pattern: [0-9]{3,64}

Responses

200

OK

application/json

404

Not Found

get

/dect_phones/{id}/members/{extension_number}

GET /api/dect_phones/{id}/members/{extension_number} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": null,
  "extension_number": null,
  "display_name": null,
  "ipui": null,
  "handset_index": null
}