Introducción

Los servicios web de usuario de VOZ Manager están desarrollados usando el estándar REST, usando JSON como formato de intercambio de datos.

URL base para servicios web

La URL base sobre la que están los servicios web de usuario es:

  • https://ssl.siptize.com/satmakapi/api/v-1.0/user

Autenticación de peticiones

Para acceder a todos los servicios indicados en esta sección, serán necesarios los siguientes datos:

  • Usuario SIP: aquí se utilizará como username
  • Contraseña web: aquí se utilizará como password

Obtener el saldo de nuestra cuenta (sólo prepago)

URL

GET /balance/<username>/<password>

Respuesta

La respuesta sera un JSON indicando el saldo

Ejemplo

  • usuario sip: 5478554756
  • contraseña web: mipassword
GET https://ssl.siptize.com/satmakapi/api/v-1.0/user/balance/5478554756/mipassword
  • Respuesta:
{
  "balance": 20.45
}

Ejemplo con curl

curl -X GET https://ssl.siptize.com/satmakapi/api/v-1.0/user/balance/5478554756/mipassword
{"balance":45.690000}

Obtener el consumo mensual

URL

GET /usage

Firma de peticiones

Las peticiciones a este servicio web deberán ir firmadas con dos cabeceras:

  • X-U: En esta cabecera hay que poner el usuario
  • X-P: En esta cabecera hay que poner el la contraseña

Respuesta

La respuesta sera un JSON indicando el consumo mensual

Ejemplo

  • usuario sip: 5478554756
  • contraseña web: mipassword
GET https://ssl.siptize.com/satmakapi/api/v-1.0/user/usage

Cabeceras:
* "X-U: 5478554756"
* "X-P: mipassword"
  • Respuesta:
{
  "usage": 84.65
}

Ejemplo con curl

curl -X GET-H "X-U: 5478554756" -H "X-P: mipassword" https://ssl.siptize.com/satmakapi/api/v-1.0/user/usage
{"usage":109.470000}

Obtener el número de registros cdr para un filtro

URL

GET /cdr/count

Filtro

Los filtros disponibles son los mismos que los indicados en la sección de CDR.

Firma de peticiones

Las peticiciones a este servicio web deberán ir firmadas con dos cabeceras:

  • X-U: En esta cabecera hay que poner el usuario
  • X-P: En esta cabecera hay que poner el la contraseña

Respuesta

La respuesta sera un JSON indicando el total de registros para el filtro indicado.

Ejemplo

  • usuario sip: 5478554756
  • contraseña web: mipassword
  • Petición indicando en el filtro:
  • from: 01/04/2020 00:00:00 UTC
  • to: 01/14/2020 23:59:59 UTC
GET https://ssl.siptize.com/satmakapi/api/v-1.0/user/cdr/count?from=1585699200000&to=1585785599999

Cabeceras:
* "X-U: 5478554756"
* "X-P: mipassword"
  • Respuesta:
{
  "count": 101
}

Ejemplo con curl

curl -X GET-H "X-U: 5478554756" -H "X-P: mipassword" "https://ssl.siptize.com/satmakapi/api/v-1.0/user/cdr/count?from=1585699200000&to=1585785599999"
{"count":38}

Obtener los registros de llamada para un filtro indicado.

URL

GET /cdr

Filtro

Los filtros disponibles son los mismos que los indicados en la sección de CDR.

Es obligatorio indicar el rango que se que quiere obtener con los parámetros rangeStart y rangeStop.

Los servicios web limitan el número máximo de registros que se pueden obtener de una única vez a 5000. El cliente debe saber primero cuántos cdrs hay para el filtro indicado mediante el método count y si supera el límite, deberá hacer petición de 5000 en 5000.

Firma de peticiones

Las peticiciones a este servicio web deberán ir firmadas con dos cabeceras:

  • X-U: En esta cabecera hay que poner el usuario
  • X-P: En esta cabecera hay que poner el la contraseña

Respuesta

La respuesta sera un array JSON con los registros de llamadas.

Ejemplo

  • usuario sip: 5478554756
  • contraseña web: mipassword
  • Petición indicando en el filtro:
  • from: 01/11/2016 00:00:00
  • to: 30/11/2016 23:59:59
  • obtener el rango desde el cdr 0 (incluído) hasta el 2 (excluído)
GET https://ssl.siptize.com/satmakapi/api/v-1.0/user/cdr?from=1585699200000&to=1585785599999&rangeStart=0&rangeStop=2

Cabeceras:
* "X-U: 5478554756"
* "X-P: mipassword"
  • Respuesta:
[
   {
      "freeField10" : null,
      "freeField9" : null,
      "diversionNumber" : null,
      "flatRateId" : null,
      "destinationName" : "Todo",
      "duration" : 219,
      "destinationNumber" : "34912123123",
      "countryIso2" : "ES",
      "freeField8" : null,
      "freeField7" : null,
      "id" : "ca958bc33adf4753969b16112438e302",
      "freeField1" : null,
      "callerIdNumber" : "34921123123",
      "created" : 1585724257000,
      "freeField3" : null,
      "direction" : "INBOUND",
      "freeField5" : null,
      "totalPrice" : 0,
      "freeField2" : null,
      "freeField4" : null,
      "billsec" : 218,
      "freeField6" : null,
      "prefixGroupName" : "Geografico",
      "accountDefaultCallerIdNumber" : "34912123123",
      "hangupCause" : "NORMAL_CLEARING"
   },
   {
    "direction" : "OUTBOUND",
    "freeField2" : null,
    "destinationNumber" : "34612123123",
    "id" : "467779d923ef47be874f0cb95844f075",
    "duration" : 47,
    "hangupCause" : "NORMAL_CLEARING",
    "flatRateId" : null,
    "freeField4" : null,
    "freeField7" : null,
    "freeField8" : null,
    "billsec" : 38,
    "freeField10" : null,
    "freeField3" : null,
    "freeField9" : null,
    "totalPrice" : 0.025,
    "callerIdNumber" : "34912123123",
    "countryIso2" : "ES",
    "accountDefaultCallerIdNumber" : "34912123123",
    "diversionNumber" : null,
    "destinationName" : "Movil TELEFONICA MOVILES",
    "created" : 1585732844000,
    "freeField6" : null,
    "freeField1" : null,
    "prefixGroupName" : "España Móvil",
    "freeField5" : null
 }
]

Ejemplo con curl

curl -X GET-H "X-U: 5478554756" -H "X-P: mipassword" "https://ssl.siptize.com/satmakapi/api/v-1.0/user/cdr?from=1585699200000&to=1585785599999&rangeStart=0&rangeStop=2"
[
   {
      "freeField10" : null,
      "freeField9" : null,
      "diversionNumber" : null,
      "flatRateId" : null,
      "destinationName" : "Todo",
      "duration" : 219,
      "destinationNumber" : "34912123123",
      "countryIso2" : "ES",
      "freeField8" : null,
      "freeField7" : null,
      "id" : "ca958bc33adf4753969b16112438e302",
      "freeField1" : null,
      "callerIdNumber" : "34921123123",
      "created" : 1585724257000,
      "freeField3" : null,
      "direction" : "INBOUND",
      "freeField5" : null,
      "totalPrice" : 0,
      "freeField2" : null,
      "freeField4" : null,
      "billsec" : 218,
      "freeField6" : null,
      "prefixGroupName" : "Geografico",
      "accountDefaultCallerIdNumber" : "34912123123",
      "hangupCause" : "NORMAL_CLEARING"
   },
   {
    "direction" : "OUTBOUND",
    "freeField2" : null,
    "destinationNumber" : "34612123123",
    "id" : "467779d923ef47be874f0cb95844f075",
    "duration" : 47,
    "hangupCause" : "NORMAL_CLEARING",
    "flatRateId" : null,
    "freeField4" : null,
    "freeField7" : null,
    "freeField8" : null,
    "billsec" : 38,
    "freeField10" : null,
    "freeField3" : null,
    "freeField9" : null,
    "totalPrice" : 0.025,
    "callerIdNumber" : "34912123123",
    "countryIso2" : "ES",
    "accountDefaultCallerIdNumber" : "34912123123",
    "diversionNumber" : null,
    "destinationName" : "Movil TELEFONICA MOVILES",
    "created" : 1585732844000,
    "freeField6" : null,
    "freeField1" : null,
    "prefixGroupName" : "España Móvil",
    "freeField5" : null
 }
]