Gestión de numeración

Mediante los servicios web aquí descritos, se podrá realizar consultas sobre la numeración.

Obtener los tipos de numeración existentes

GET /did/types

Permisos

Acceso a los datos de del softswitch asignado a la Api Key utilizada.

Petición

El servicio espera una petición GET sin parámetros y devolverá un array con los objectos asociados.

Respuesta

La respuesta en un JSON con un array con los tipos de numeración existentes.

Ejemplo

• Petición

GET https://ssl.siptize.com/satmakapi/api/v-1.0/did/types

• Respuesta

El sistema responde con un JSON con un array con los tipos de numeración:

[
   {
      "name" : "Número 900",
      "id" : "ff808181724b91b601724b91b66c0000"
   },
   {
      "name" : "Geográfico",
      "id" : "ff808181719d58bb01719d58bd09016c"
   }
]

Obtener los números

GET /did

Permisos

Acceso a los datos del softswitch asignado a la Api Key utilizada.

Petición

El servicio espera una petición GET con el filtro (opcional) como parámetros de la URL, de no ser así, devolverá un 400 (Bad Request). Devolverá un array con los números existentes.

Parámetros de la petición

Nombre	Descripción	Tipo
unassigned	Números no asignados	Booleano

Respuesta

La respuesta en un JSON con un array con los números

Ejemplo

• Petición

GET https://ssl.siptize.com/satmakapi/api/v-1.0/did

• Respuesta

El sistema responde con un JSON con un array con los números:

[
   {
      "aliasNumber" : null,
      "countryIso2" : "ES",
      "destination" : null,
      "accountId" : "ff808181719d58bb01719d58bef7017e",
      "active" : true,
      "didTypeId" : "ff808181719d58bb01719d58bd09016c",
      "destinationType" : "USER",
      "number" : "34961154175",
      "providerId" : "ff808181719d58bb01719d58bd030168"
   },
   {
      "countryIso2" : "ES",
      "aliasNumber" : null,
      "destination" : null,
      "accountId" : "ff808181719d58bb01719d58becf0179",
      "active" : true,
      "didTypeId" : "ff808181719d58bb01719d58bd09016c",
      "destinationType" : "USER",
      "providerId" : "ff808181719d58bb01719d58bd030168",
      "number" : "34966261122"
   }
]

Crear un número

PUT /did

Permisos

Acceso a los datos del softswitch asignado a la Api Key utilizada.

Petición

La petición es un JSON con los siguientes campos

Nombre	Descripción	Tipo	Obligatorio	Comentarios
number	Número, en formato E164 sin el +	String	Sí
didTypeId	Id de tipo de numeración	String	Sí
countryIso2	ISO 2 de país del número	String	Sí
providerId	Id del proveedor	String	Sí
aliasNumber	Número alias	String	No
destinationType	Tipo de destino	Enumerado (USER/SOFIA_STRING)	No
destination	Destino	Numérico	No	Sólo si se usa un destinationType "CUSTOM"
accountId	Id de la cuenta de usuario	Numérico	No

Ejemplo

• Petición

PUT https://ssl.siptize.com/satmakapi/api/v-1.0/did
{
  "number": "34911222333",
  "didTypeId": "ff808181719d58bb01719d58bd09016c",
  "countryIso2": "ES",
  "providerId": "ff808181719d58bb01719d58bd030168"
}

• Respuesta

Respuesta HTTP: 201
Location: https://ssl.siptize.com/satmakapi/api/v-1.0/account/34911222333

Actualizar un número

POST /did/<didNumber>

Permisos

Acceso a los datos del softswitch asignado a la Api Key utilizada.

Petición

La petición es un JSON con los siguientes campos

Nombre	Descripción	Tipo	Obligatorio	Comentarios
didTypeId	Id de tipo de numeración	String	Sí
countryIso2	ISO 2 de país del número	String	Sí
providerId	Id del proveedor	String	Sí
aliasNumber	Número alias	String	No
destinationType	Número por defecto	String	Sí
destination	Saldo	Numérico	No
accountId	Saldo	Numérico	No

Ejemplo

• Petición

POST https://ssl.siptize.com/satmakapi/api/v-1.0/did/34911222333

• Petición

{
  "number": "34911222333",
  "didTypeId": "ff808181719d58bb01719d58bd09016c",
  "countryIso2": "ES",
  "providerId": "ff808181719d58bb01719d58bd030168"
}

• Respuesta

Respuesta HTTP: 200

Asignar un número a una cuenta

GET /did/<didNumber>/assign/<accountId>

Permisos

Acceso a los datos del softswitch asignado a la Api Key utilizada.

Petición

Se realiza un GET indicando el número que se quiere asignar y el id de la cuenta.

Ejemplo

• Petición

GET https://ssl.siptize.com/satmakapi/api/v-1.0/did/34911123123/assign/ff808181719d58bb01719d58bd030175

• Respuesta

Respuesta HTTP: 200

Desasignar un número

GET /did/<didNumber>/release

Permisos

Acceso a los datos del softswitch asignado a la Api Key utilizada.

Petición

Se realiza un GET indicando el número que se quiere desasignar.

Ejemplo

• Petición

GET https://ssl.siptize.com/satmakapi/api/v-1.0/did/34911123123/release

• Respuesta

Respuesta HTTP: 200