Gestión de extensiones

Mediante los servicios web aquí descritos, se podrá realizar cambios en las extensiones de centralita.

Permisos

Acceso a la búsqueda y edición de extensiones en la centralita asignada a la Api Key utilizada.

Obtener todas las extensiones

Con éste método obtenemos todas las extensiones de la centralita en un array JSON

GET /extension

Ejemplo
  • Petición
GET https://vpbx.me/api/extension
  • Respuesta
[
  {
    "id": "ff8081815814fad501586cf44fe506bd",
    "name": "20",
    "username": "20",
    "type": "SIP",
    "email": null,
    "outboundId": "ff808181544ddfa801546265bcdd00dd",
    "cw": true,
    "dnd": false,
    "webPassword": "45Adbdd",
    "webLogin": true
  },
  {
    "id": "ff808181544ddfa8015462665fc400e8",
    "name": "21",
    "username": "21",
    "type": "SIP",
    "email": "21@demo.es",
    "outboundId": "ff808181544ddfa801546265bcdd00dd",
    "cw": true,
    "dnd": true,
    "webPassword": "Demodemo1",
    "webLogin": true,
    "cfa": "614123123",
    "cfb": "614123123",
    "cfna": "614123123",
    "cfu": "614123123"
  },
  {
    "id": "ff80818159025d810159939ec18804a8",
    "name": "Rafael",
    "username": "22",
    "type": "SIP",
    "email": "jesus@demo.es",
    "outboundId": "ff808181544ddfa801546265bcdd00dd",
    "cw": true,
    "dnd": false,
    "webPassword": "5Eahuaiz",
    "webLogin": true
  },
  {
    "id": "ff80818156227cc80156fec40bbe0273",
    "name": "Manuel",
    "username": "25",
    "type": "VIRTUAL",
    "email": "manuel@demo.es",
    "outboundId": "ff808181544ddfa801546265bcdd00dd",
    "cw": true,
    "dnd": false,
    "webPassword": "y873501X",
    "webLogin": false
  }
]

Obtener datos de una extensión

GET /extension/<id de extensión>

Ejemplo
  • Petición
GET https://vpbx.me/api/extension/ff8081815814fad501586cf44fe506bd
  • Respuesta
{
  "id": "ff8081815814fad501586cf44fe506bd",
  "name": "20",
  "username": "20",
  "type": "SIP",
  "email": null,
  "outboundId": "ff808181544ddfa801546265bcdd00dd",
  "cw": true,
  "dnd": false,
  "webPassword": "45Adbdd",
  "webLogin": true
}

Buscar id de extensión por nombre de usuario (username)

GET /extension/findbyusername/<username>

Ejemplo
  • Petición
GET https://vpbx.me/api/extension/findbyusername/20
  • Respuesta
{
  "username": "20",
  "extensionId": "ff8081815814fad501586cf44fe506bd"
}

Respuesta

La respuesta es un json con los siguientes campos

Nombre Descripción Tipo Comentarios
extensionId id de extensión String
username username utilizado en la consulta String
Ejemplo
  • Petición
GET https://vpbx.me/api/extension/findbyusername/100
  • Respuesta
{
  "extensionId":"ff8081814a53b218014a53b2206c00ff",
  "username":"100"
}

Actualizar información de una extensión

POST /extension/<id de extensión>

Petición

El servicio espera una petición en formato JSON ("Content-Type: application/json"), de no ser así, devolverá un 400 (Bad Request).

Las propiedades que se pueden cambiar de una extensión son

Nombre Descripción Tipo Comentario
name Nombre String
email Email String
outboundId Id del outbound a asignar String
cw Llamada en espera boolean
dnd No molestar boolean
cfa Desvío incondicional String
cfb Desvío si ocupado String
cfna Desvío si no contesta String
cfu Desvío si no disponible String
webPassword Contraseña web String
webLogin Acceso web boolean

Respuesta

La respuesta en un JSON con los siguientes campos

Nombre Descripción Tipo Comentario
extensionId Id de extensión String

Ejemplo

  • Petición
POST https://vpbx.me/api/extension/ff8081814a53b218014a53b2206c00ff
{
  "name": "Nuevo nombre",
  "email": "nuevoemail@demo.es",
  "cfa": "601456456"
}
  • Respuesta

El sistema responde con un 200 si se ha actualizado con éxito la extensión.