Gestión de cuentas
Mediante los servicios web aquí descritos, se podrá realizar consultas sobre las cuentas
Obtener todos los id's de cuentas
GET /account/ids
Permisos
Acceso a los datos de cuentas 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).
Parámetros de la petición
| Nombre | Descripción | Tipo |
|---|---|---|
| balanceFrom | Saldo mayor a | Numérico |
| balanceTo | Saldo menor a | Numérico |
| paymentType | Forma de pago | Enumerado (POSTPAID/PREPAID) |
| state | Estado de la cuenta | Enumerado |
Respuesta
La respuesta en un JSON con un array de strings con los ids de la cuentas
Ejemplo
- Petición
GET https://ssl.siptize.com/satmakapi/api/v-1.0/account/ids?paymentType=POSTPAID
- Respuesta
El sistema responde con un JSON con un array de ids:
[
"aa8081814a10b218014a53b220840123",
"bb8081814a21b216384a53b220840456",
"cc8081814a36b211594a53b220840789",
"008081814a96b217534a53b220840741",
"118081814a53b217964a53b220840852",
]
Obtener todas las cuentas
GET /account
Permisos
Acceso a los datos de cuentas 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).
Parámetros de la petición
| Nombre | Descripción | Tipo |
|---|---|---|
| balanceFrom | Saldo mayor a | Numérico |
| balanceTo | Saldo menor a | Numérico |
| paymentType | Forma de pago | Enumerado (POSTPAID/PREPAID) |
| state | Estado de la cuenta | Enumerado |
Respuesta
La respuesta en un JSON con un array de cuentas
Ejemplo
- Petición
GET https://ssl.siptize.com/satmakapi/api/v-1.0/account?paymentType=POSTPAID
- Respuesta
El sistema responde con un JSON con un array de ids:
[
{
"maxMonthUsage" : 50,
"username" : "9910365982356",
"cfb" : null,
"notifyVoicemail" : false,
"state" : "ACTIVE",
"name" : "Nuevo nombre de cliente",
"id" : "ff808181724b6a4c01724b6a4c660000",
"attachWav" : true,
"anyCallerIdNumber" : false,
"cfna" : null,
"allowedCallerIdNumbers" : [
"34966261122"
],
"notifyEmails" : [],
"voicemailPin" : "5008",
"maxInCalls" : 0,
"cfa" : null,
"maxCalls" : 5,
"delVmOnSend" : true,
"maxDayUsage" : 10,
"paymentType" : "POSTPAID",
"rateGroupId" : "ff808181719d58bb01719d58bc5f00fa",
"defaultCallerIdNumber" : "34966261122",
"ref" : null,
"countryIso2" : "ES",
"proxyType" : "DEFAULT",
"cfu" : null,
"password" : "4JNyB1Om",
"maxOutCalls" : 0,
"dids" : [],
"balance" : null
},
{
"defaultCallerIdNumber" : "34966261122",
"ref" : null,
"countryIso2" : "ES",
"proxyType" : "DEFAULT",
"dids" : [
"34966261122"
],
"balance" : null,
"cfu" : null,
"maxOutCalls" : 0,
"password" : "123456SipTize123456",
"delVmOnSend" : true,
"maxCalls" : 5,
"maxInCalls" : 0,
"voicemailPin" : "1234",
"cfa" : null,
"rateGroupId" : "ff808181719d58bb01719d58bc5f00fa",
"maxDayUsage" : 10,
"paymentType" : "POSTPAID",
"allowedCallerIdNumbers" : [
"34966261122"
],
"anyCallerIdNumber" : false,
"cfna" : null,
"notifyEmails" : [
"info@siptize.com"
],
"state" : "ACTIVE",
"notifyVoicemail" : false,
"maxMonthUsage" : 50,
"username" : "5940924575657",
"cfb" : null,
"attachWav" : true,
"id" : "ff808181719d58bb01719d58becf0179",
"name" : "Test Pospago"
}
]
Obtener datos de una cuenta
GET /account/<id de cuenta>
Permisos
Acceso a los datos de cuentas del softswitch asignado a la Api Key utilizada.
Respuesta
La respuesta es un json con los siguientes campos
| Nombre | Descripción | Tipo | Comentarios |
|---|---|---|---|
| id | id de cuenta | String | |
| username | username SIP | String | |
| paymentType | Forma de pago | Enumerado (POSTPAID/PREPAID) | |
| balance | Saldo | Numérico | |
| maxMonthUsage | Límite mensual | Numérico | |
| maxDayUsage | Límite diario | Numérico | |
| state | Estado de la cuenta | Enumerado | |
| rateGroupId | Id de tarifa | String | |
| name | Nombre de la cuenta | String | |
| ref | Referencia | String | |
| password | Contraseña SIP | String | |
| anyCallerIdNumber | Permitir cualquier número | Booleano | |
| defaultCallerIdNumber | Número por defecto | String | |
| allowedCallerIdNumbers | Números permitidos | Array de String | |
| dids | Números asignados | Array de String | |
| proxyType | Tratamiento del media | Enumerado | |
| maxOutCalls | Límite llamadas salientes | Numérico | |
| maxInCalls | Límite llamadas entrantes | Numérico | |
| cfa | Desvío incondicional | String | |
| cfb | Desvío ocupado | String | |
| cfna | Desvío no contesta | String | |
| cfu | Desvío no disponibles | String | |
| notifyEmails | Emails de notificación | Array de String | |
| voicemailPin | pin voicemail | Numérico | |
| notifyVoicemail | Notificar al email los mensajes del buzón | Booleano | |
| delVmOnSend | Borrar los mensajes al enviar | Booleano | |
| attachWav | Adjuntar grabación del buzón | Booleano | |
| countryIso2 | ISO 2 de país de la cuenta | String |
Ejemplo
- Petición
GET https://ssl.siptize.com/satmakapi/api/v-1.0/account/96132d2d83ea48d7a566c6eae90b9915
- Respuesta
{
"countryIso2": "ES",
"attachWav": true,
"delVmOnSend": true,
"notifyVoicemail": false,
"voicemailPin": "8787",
"notifyEmails": [
"info@siptize.com"
],
"cfu": null,
"cfna": null,
"cfb": null,
"cfa": null,
"maxInCalls": 0,
"maxOutCalls": 3,
"rateGroupId": "0000818b3ee64d9a003ee652ba000008",
"state": "ACTIVE",
"maxDayUsage": 30,
"maxMonthUsage": 100,
"balance": null,
"paymentType": "POSTPAID",
"username": "9200989112600",
"id": "96132d2d83ea48d7a566c6eae90b9915",
"name": "Cliente 1",
"ref": null,
"password": "aAaZZzzz1234",
"anyCallerIdNumber": false,
"defaultCallerIdNumber": "34966261122",
"allowedCallerIdNumbers": [
"34966261122"
],
"dids": [
"34902000000",
"34966261122"
],
"proxyType": "DEFAULT"
}
Crear una cuenta
PUT /account
Permisos
Acceso a los datos de cuentas 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 |
|---|---|---|---|---|
| paymentType | Forma de pago | Enumerado (POSTPAID/PREPAID) | Sí | |
| state | Estado de la cuenta | Enumerado | Sí | |
| rateGroupId | Id de tarifa | String | Sí | |
| defaultCallerIdNumber | Número por defecto | String | Sí | |
| countryIso2 | ISO 2 de país de la cuenta | String | Sí | |
| balance | Saldo | Numérico | No | |
| maxMonthUsage | Límite mensual | Numérico | No | |
| maxDayUsage | Límite diario | Numérico | No | |
| proxyType | Tratamiento del media | Enumerado | No | |
| name | Nombre de la cuenta | String | No | |
| ref | Referencia | String | No | |
| password | Contraseña SIP | String | No | |
| anyCallerIdNumber | Permitir cualquier número | Booleano | No | |
| maxCalls | Límite llamadas | Numérico | No | |
| allowedCallerIdNumbers | Números permitidos | Array de String | No | |
| maxOutCalls | Límite llamadas salientes | Numérico | No | |
| maxInCalls | Límite llamadas entrantes | Numérico | No | |
| cfa | Desvío incondicional | String | No | |
| cfb | Desvío ocupado | String | No | |
| cfna | Desvío no contesta | String | No | |
| cfu | Desvío no disponibles | String | No | |
| notifyEmails | Emails de notificación | Array de String | No | |
| voicemailPin | pin voicemail | Numérico | No | |
| notifyVoicemail | Notificar al email los mensajes del buzón | Booleano | No | |
| delVmOnSend | Borrar los mensajes al enviar | Booleano | No | |
| attachWav | Adjuntar grabación del buzón | Booleano | No |
Ejemplo
- Petición
PUT https://ssl.siptize.com/satmakapi/api/v-1.0/account
- Petición
{
"paymentType": "POSTPAID",
"state": "ACTIVE",
"rateGroupId": "0000818b3ee64d9a003ee652ba000008",
"defaultCallerIdNumber": "34966261122",
"countryIso2": "ES",
"name": "Cliente 1"
}
- Respuesta
Respuesta HTTP: 201
Location: https://ssl.siptize.com/satmakapi/api/v-1.0/account/ff808181724b6a4c01724b6a4c660000
De la cabecera "Location" podemos obtener el id de la cuenta creada.
Actualizar una cuenta
POST /account/<accountId>
Permisos
Acceso a los datos de cuentas 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 |
|---|---|---|---|---|
| paymentType | Forma de pago | Enumerado (POSTPAID/PREPAID) | No | |
| state | Estado de la cuenta | Enumerado | No | |
| rateGroupId | Id de tarifa | String | No | |
| defaultCallerIdNumber | Número por defecto | String | No | |
| countryIso2 | ISO 2 de país de la cuenta | String | No | |
| balance | Saldo | Numérico | No | |
| maxMonthUsage | Límite mensual | Numérico | No | |
| maxDayUsage | Límite diario | Numérico | No | |
| proxyType | Tratamiento del media | Enumerado | No | |
| name | Nombre de la cuenta | String | No | |
| ref | Referencia | String | No | |
| password | Contraseña SIP | String | No | |
| anyCallerIdNumber | Permitir cualquier número | Booleano | No | |
| maxCalls | Límite llamadas | Numérico | No | |
| allowedCallerIdNumbers | Números permitidos | Array de String | No | |
| maxOutCalls | Límite llamadas salientes | Numérico | No | |
| maxInCalls | Límite llamadas entrantes | Numérico | No | |
| cfa | Desvío incondicional | String | No | |
| cfb | Desvío ocupado | String | No | |
| cfna | Desvío no contesta | String | No | |
| cfu | Desvío no disponibles | String | No | |
| notifyEmails | Emails de notificación | Array de String | No | |
| voicemailPin | pin voicemail | Numérico | No | |
| notifyVoicemail | Notificar al email los mensajes del buzón | Booleano | No | |
| delVmOnSend | Borrar los mensajes al enviar | Booleano | No | |
| attachWav | Adjuntar grabación del buzón | Booleano | No |
Ejemplo
- Petición
POST https://ssl.siptize.com/satmakapi/api/v-1.0/account/ff808181724b6a4c01724b6a4c660000
- Petición
{
"name": "Nuevo nombre de cliente"
}
- Respuesta
Respuesta HTTP: 200
Obtener el consumo mensual de una cuenta
GET /account/<accountId>/monthuse
Permisos
Acceso a los datos de cuentas del softswitch asignado a la Api Key utilizada.
Petición
Se realiza un GET indicando el "accountId" y se espera un texto plano con el consumo mensual.
Ejemplo
- Petición
GET https://ssl.siptize.com/satmakapi/api/v-1.0/account/ff808181724b6a4c01724b6a4c660000/monthuse
- Respuesta
19.361000
Obtener el consumo diario de una cuenta
GET /account/<accountId>/dayuse
Permisos
Acceso a los datos de cuentas del softswitch asignado a la Api Key utilizada.
Petición
Se realiza un GET indicando el "accountId" y se espera un texto plano con el consumo diario.
Ejemplo
- Petición
GET https://ssl.siptize.com/satmakapi/api/v-1.0/account/ff808181724b6a4c01724b6a4c660000/dayuse
- Respuesta
5.724000
Incrementar el saldo de una cuenta prepago
POST /account/<accountId>/addbalance
Permisos
Acceso a los datos de cuentas del softswitch asignado a la Api Key utilizada.
Petición
Se realiza un POST indicando el "accountId" y con los parámetros de la recarga.
Ejemplo
- Petición
POST https://ssl.siptize.com/satmakapi/api/v-1.0/account/ff808181724b6a4c01724b6a4c660000/addbalance
- Petición
{
"amount": 10,
"reference": "my ref",
"comment": "mi comentario"
}
- Respuesta
Respuesta HTTP: 200