Listar Contactos
URL:https://www.onurix.com/api/v1/contacts/list
Lista todos los contactos divididos por grupos que posee el cliente
Parametros.
| Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
| client | integer(int64) | true | El Id del cliente |
| key | string | true | Key de la cuenta Onurix |
| page | integer | false | Número de página a retornar. Por defecto 1. Máximo 50 items por página. |
Responses.
| Estado | Significado | Descripción | Esquema |
|---|---|---|---|
| 200 | OK | Operación exitosa | JsonResponse |
| 400 | Client Error | Parametros invalidos | JsonResponse |
| 520 | Unknown | Error interno del sistema | ErrorResponse |
Body parameters
client: 0,
key: "string"
Respuesta de ejemplo
Response 200
{
"metadata": {
"current_page": 1,
"per_page": 50,
"total_items": 2,
"total_pages": 1
},
"grouped_contacts": {
"1": [
{
"id": 1,
"name": "DummyName1",
"lastname": "DummyLastname1",
"phone": "1234567890",
"email": "dummy1@example.com"
},
{
"id": 2,
"name": "DummyName2",
"lastname": "DummyLastname2",
"phone": "0987654321",
"email": "dummy2@example.com"
}
],
"2": [
{
"id": 3,
"name": "DummyName3",
"lastname": "DummyLastname3",
"phone": "1122334455",
"email": "dummy3@example.com"
}
]
}
}
Response 400 o 520
{
"error": 1000,
"msg": "string"
}
Si requiere asistencia o tiene un problema, envienos un mensaje para poder ayudarlo
soporte@onurix.com