SIP CallerSIP Caller
Tabla de Contenidos
    Descripción General
    🔐 Autenticación
    Cómo Crear una API Key
    Encabezado de Ejemplo
    🌐 URL de Base
    👤 Roles & Permisos
    📌 Descripción General de los Métodos
    👥 Partners
    Listar Partners Asociados
    Request Example
    Ejemplo de Respuesta
    Crear Partner Asociado
    Cuerpo de la Solicitud
    Solicitud de Ejemplo
    Respuesta de Ejemplo
    🧑‍💼 Clientes
    Listar Clientes
    Ejemplo de Solicitud
    Respuesta de Ejemplo
    Crear Cliente
    Cuerpo de la Solicitud
    Solicitud de Ejemplo
    Respuesta de Ejemplo

Descripción General

La API REST para partners permite que sistemas externos gestionen partners y clientes mediante programación dentro del ecosistema SIP Caller.

Esta API está diseñada para Distribuidores y Partners que necesitan automatizar las tareas de incorporación y gestión.

🔐 Autenticación

Todas las solicitudes a la API requieren autenticación mediante un Bearer Token.

Cómo Crear una API Key

  1. Inicia sesión en la Consola de Partners de SIP Caller
  2. Navega a Configuración > API Keys
  3. Crea una nueva API key
  4. Copia el Token de la API key generado

Encabezado de Ejemplo

Incluye el token de la API key en el encabezado Authorization:

Authorization: Bearer TU_API_KEY_TOKEN

🌐 URL de Base

Cada solicitud debe enviarse a la siguiente URL base:

https://api.sipcaller.com/v1/

👤 Roles & Permisos

RolPermiso
PartnerReaderSolo puede leer datos de partners y clientes existentes.
PartnerAdminPuede leer datos de partners y clientes existentes, y crear otros nuevos.

📌 Descripción General de los Métodos

MétodoEndpointDescripciónRol Requerido
GET/partnersListar partners asociadosPartnerReader (Distribuidor)
POST/partnersCrear partner asociadoPartnerAdmin (Distribuidor)
GET/customersListar clientesPartnerReader (Partner / Distribuidor)
POST/customersCrear clientePartnerAdmin (Partner / Distribuidor)

👥 Partners

Listar Partners Asociados

GET /partners

Retorna todos los partners asociados con el distribuidor autenticado.

Request Example

curl -i \
--header 'Authorization: Bearer API_KEY_TOKEN' \
--get \
--data-urlencode 'filter={"name":"ACME","countryIds_ovl":["us"],"code":"acme","state":"Active","level":["Basic","Certified"],"createdAt_gte":"2026-03-01","createdAt_lte":"2026-04-01"}' \
--data-urlencode 'sort=["name","DESC"]' \
--data-urlencode 'range=[0,99]' \
'https://api.sipcaller.com/v1/partners'

La solicitud permite especificar filtros, ordenación y rango:

  • La instrucción filter puede especificar cualquiera de los siguientes campos:
    • filter={"name":"Partner Name"}
    • filter={"countryIds_ovl":["us","ar"]}
    • filter={"code":"Partner Code"}
    • filter={"state":"Active"} – Estados: Active, SignedUp
    • filter={"level":["Basic","Certified","Premium"]} – Niveles: Basic, Certified, Premium
    • filter={"createdAt_gte":"2026-01-01"} – Sufijos gte, gt, lte, lt
  • La instrucción de ordenación puede especificar cualquiera de los siguientes campos, tanto ascendente (ASC) como descendente (DESC):
    • name
    • countryName
    • code
    • state
    • level
    • createdAt

Ejemplo de Respuesta

[
    {
        "id": "019cea04-b015-7f54-a7dd-6e5c198f15a9",
        "name": "ACME",
        "type": "Partner",
        "code": "acme",
        "countryIds": [
            "us"
        ],
        "state": "Active",
        "level": "Basic",
        "parent": {
            "id": "019cea04-b00f-76a3-b584-025a91dc697e",
            "name": "Distributor Name",
            "type": "Distributor",
            "contactData": {
                "web": "https://distributor.example.com",
                "email": "sales@distributor.example.com",
                "phone": "+1 234 555 0000"
            }
        },
        "signUpData": {
            "comments": "We want to become a SIP Caller partner.",
            "originType": "HomeSite",
            "websiteUrl": "https://acme.example.com"
        },
        "contactData": {
            "public": {
                "web": "https://acme.example.com",
                "email": "sales@acme.example.com",
                "phone": "+1 234-555-0001"
            },
            "members": [
                {
                    "id": "019cea04-b016-75ea-8b2f-a87a96005e82",
                    "name": "John Doe",
                    "email": "john.doe@acme.example.com",
                    "phoneNumber": "+1 234 555-0002",
                    "languageId": "en",
                    "timeZoneId": "US/Eastern",
                    "roles": [
                        "PartnerAdmin"
                    ]
                }
            ]
        },
        "counters": {
            "apiKeys": {
                "created": 0,
                "deleted": 0
            }
        },
        "customersCount": 1,
        "createdAt": "2026-03-14T01:45:01.717",
        "updatedAt": "2026-03-14T01:45:01.717"
    }
]

Crear Partner Asociado

POST /partners

Crea un nuevo partner bajo el distribuidor autenticado.

Cuerpo de la Solicitud

{
    "email": "john.doe@partner.example.com",
    "firstName": "John",
    "lastName": "Doe",
    "partnerName": "Example Partner",
    "type": "Partner",
    "code": "example-partner",
    "level": "Basic",
    "languageId": "en",
    "timeZoneId": "US/Eastern",
    "countryIds": [
        "us",
        "ca"
    ],
    "contactData": {
        "web": "https://partner.example.com",
        "email": "john.doe@partner.example.com",
        "phone": "+1 234 555-0000"
    },
    "logo": {
        "file": "example-partner.png",
        "maxHeight": 60
    }
}

Solicitud de Ejemplo

curl -i \
--header 'Authorization: Bearer API_KEY_TOKEN' \
--request POST \
--data-raw '{ "email": "john.doe@partner.example.com", "firstName": "John", "lastName": "Doe", "partnerName": "Example Partner", "type": "Partner", "code": "example-partner", "level": "Basic", "languageId": "en", "timeZoneId": "US/Eastern", "countryIds": [ "us", "ca" ], "contactData": { "web": "https://partner.example.com", "email": "john.doe@partner.example.com", "phone": "+1 234 555-0000" }, "logo": { "file": "example-partner.png", "maxHeight": 60 } }' \
'https://api.sipcaller.com/v1/partners'

Respuesta de Ejemplo

{
    "id": "019d0cfc-19eb-7017-8166-f007ebfbe70c",
    "name": "Eample Partner",
    "type": "Partner",
    "code": "example-partner",
    "countryIds": [
        "us",
        "ca"
    ],
    "state": "Active",
    "level": "Basic",
    "parent": {
        "id": "019cea04-b002-7271-be0b-3fdbbc483aba",
        "name": "Example Distributor",
        "type": "Distributor",
        "contactData": {
            "web": "https://distributor.example.com",
            "email": "sales@distributor.example.com",
            "phone": "+1 234 555 0001"
        }
    },
    "signUpData": {
        "originType": "PartnerApiKey"
    },
    "contactData": {
        "public": {
            "web": "https://partner.example.com",
            "email": "john.doe@partner.example.com",
            "phone": "+1 234 555-0000"
        },
        "members": [
            {
                "id": "019d0cfc-19eb-7c4d-9b70-b6e5e926be3f",
                "name": "John Doe",
                "email": "john.doe@partner.example.com",
                "phoneNumber": "+1 234 555-0000",
                "languageId": "en",
                "timeZoneId": "US/Eastern",
                "roles": [
                    "PartnerAdmin"
                ]
            }
        ]
    },
    "counters": {
        "apiKeys": {
            "created": 0,
            "deleted": 0
        }
    },
    "customersCount": 0,
    "createdAt": "2026-03-20T20:42:21.545",
    "updatedAt": "2026-03-20T20:42:21.545"
}

🧑‍💼 Clientes

Listar Clientes

GET /customers

Devuelve todos los clientes asociados con el partner o distribuidor autenticado.

Ejemplo de Solicitud

curl -i \
--header 'Authorization: Bearer API_KEY_TOKEN' \
--get \
--data-urlencode 'filter={"name":"Customer Name","countryId":["us","ar"],"planId":["ent-4sc-y"],"state":["Trialing"],"createdAt_gte":"2026-03-01","createdAt_lte":"2026-04-01"}' \
--data-urlencode 'sort=["name","DESC"]' \
--data-urlencode 'range=[0,99]' \
'https://api.sipcaller.com/v1/customers'

La solicitud permite especificar filtros, ordenación y rango:

  • La instrucción filter puede especificar cualquiera de los siguientes campos:
    • filter={"name":"Customer Name"}
    • filter={"countryId":["us","ar"]}
    • filter={"planId":"ent-4sc-y"} - El identificador del plan se construye de la siguiente manera: ess / pro / ent (para Essentials, Professional o Enterprise), seguido del número de llamadas simultáneas y, a continuación, un sufijo que indica el ciclo de facturación (m para mensual, y para anual). Por ejemplo: pro-8sc-m, ent-16sc-y, etc.
    • filter={"state":"Trialing"} – Estado: FreePlan, PartnerPlan, Trialing, TrialExpired, SubscriptionActive, SubscriptionPastDue, SubscriptionExpired, Closed, Suspended, Abandoned
    • filter={"createdAt_gte":"2026-01-01"} – Sufijos gte, gt, lte, lt
  • La instrucción de ordenación puede especificar cualquiera de los siguientes campos, tanto ascendente (ASC) como descendente (DESC):
    • name
    • countryName
    • planName
    • createdAt

Respuesta de Ejemplo

[
    {
        "id": "019d06bc-cce2-7310-99b4-fc67f0090456",
        "name": "Example Customer",
        "countryId": "us",
        "state": "Trialing",
        "planId": "ent-4sc-y",
        "ownerType": "Customer",
        "signUpData": {
            "originType": "PartnerConsole",
            "websiteUrl": "https://customer.example.com"
        },
        "contactData": {
            "members": [
                {
                    "id": "019d06bc-ccea-7ad7-b6bd-76bb684636fd",
                    "name": "John Doe",
                    "email": "john.doe@customer.example.com",
                    "phoneNumber": "+1 234 555-0001",
                    "languageId": "en",
                    "timeZoneId": "US/Eastern",
                    "roles": [
                        "AccountAdmin"
                    ]
                }
            ]
        },
        "partner": {
            "id": "019cea04-b00f-76a3-b584-025a91dc697f",
            "name": "Example Partner",
            "type": "Partner"
        },
        "counters": {
            "phoneSystems": {
                "created": 0,
                "deleted": 0
            },
            "callflows": {
                "created": 0,
                "deleted": 0
            },
            "campaigns": {
                "created": 0,
                "deleted": 0,
                "activated": {
                    "powerDialer": 0,
                    "predictiveDialer": 0,
                    "progressiveDialer": 0
                }
            },
            "apiKeys": {
                "created": 0,
                "deleted": 0
            },
            "webhookEndpoints": {
                "created": 0,
                "deleted": 0
            },
            "webhookEvents": {
                "created": 0,
                "delivered": 0
            },
            "calls": {
                "powerDialer": {
                    "answer": 0,
                    "noAnswer": 0,
                    "busy": 0,
                    "callError": 0
                },
                "predictiveDialer": {
                    "answer": 0,
                    "noAnswer": 0,
                    "busy": 0,
                    "callError": 0
                },
                "progressiveDialer": {
                    "agentAnswer": {
                        "numberConnected": 0,
                        "numberNotConnected": 0,
                        "numberConnectionUnknown": 0,
                        "numberNotCalled": 0
                    },
                    "agentNoAnswer": 0,
                    "agentBusy": 0,
                    "agentCallError": 0
                }
            }
        },
        "ttsUsage": {
            "monthlyPeriod": {
                "startAt": "2026-03-19T15:00:00",
                "endAt": "2026-04-19T15:00:00"
            },
            "maxChars": 1500000,
            "usedChars": 0,
            "isLimitReached": false,
            "usageDetails": []
        },
        "createdAt": "2026-03-19T15:35:29.75",
        "updatedAt": "2026-03-19T15:35:29.75"
    }
]

Crear Cliente

POST /customers

Crea un nuevo cliente bajo el partner o distribuidor autenticado.

Cuerpo de la Solicitud

{
    "countryId": "us",
    "languageId": "en",
    "timeZoneId": "US/Eastern",
    "email": "john.doe@customer.example.com",
    "customerName": "Example Customer",
    "firstName": "John",
    "lastName": "Doe",
    "websiteUrl": "https://customer.example.com",
    "phoneNumber": "+1 234 555-0001",
    "partnerId": "019cea04-b002-7271-be0b-3fdbbc483ab9",
    "partnerMemberIdForCustomerSupport": "019cea04-b005-73e2-9d0f-8ccf53da5c0c"
}

Solicitud de Ejemplo

curl -i \
--header 'Authorization: Bearer API_KEY_TOKEN' \
--request POST \
--data-raw '{ "countryId": "us", "languageId": "en", "timeZoneId": "US/Eastern", "email": "john.doe@customer.example.com", "customerName": "Example Customer", "firstName": "John", "lastName": "Doe", "websiteUrl": "https://customer.example.com", "phoneNumber": "+1 234 555-0001", "partnerId": "019cea04-b002-7271-be0b-3fdbbc483ab9", "partnerMemberIdForCustomerSupport": "019cea04-b005-73e2-9d0f-8ccf53da5c0c"}' \
'https://api.sipcaller.com/v1/customers'

Los siguientes campos son opcionales:

  • partnerId: este es el ID del partner que se asociará con el nuevo cliente. Si no se proporciona, el sistema asociará automáticamente al cliente con el partner del usuario autenticado. Esto resulta útil para los distribuidores que desean crear clientes ya asociados con un partner específico.
  • partnerMemberIdForCustomerSupport: este es el ID de un miembro del partner que se asociará con el nuevo cliente para fines de soporte. Si se proporciona, este miembro podrá acceder a la cuenta del cliente en la consola de SIP Caller, para brindar soporte.

Respuesta de Ejemplo

{
    "id": "019d1bbc-85f8-7336-8034-ad4707badc52",
    "name": "Example Customer",
    "countryId": "us",
    "state": "Trialing",
    "planId": "ent-4sc-y",
    "ownerType": "Customer",
    "signUpData": {
        "originType": "PartnerApiKey",
        "websiteUrl": "https://customer.example.com"
    },
    "contactData": {
        "members": [
            {
                "id": "019d1bbc-85ff-74eb-87df-1f50fb2fcfc3",
                "name": "John Doe",
                "email": "john.doe@customer.example.com",
                "phoneNumber": "+1 234 555-0001",
                "languageId": "en",
                "timeZoneId": "US/Eastern",
                "roles": [
                    "AccountAdmin"
                ]
            }
        ]
    },
    "partner": {
        "id": "019cea04-b002-7271-be0b-3fdbbc483ab8",
        "name": "Example Partner",
        "type": "Partner"
    },
    "counters": {
        "phoneSystems": {
            "created": 0,
            "deleted": 0
        },
        "callflows": {
            "created": 0,
            "deleted": 0
        },
        "campaigns": {
            "created": 0,
            "deleted": 0,
            "activated": {
                "powerDialer": 0,
                "predictiveDialer": 0,
                "progressiveDialer": 0
            }
        },
        "apiKeys": {
            "created": 0,
            "deleted": 0
        },
        "webhookEndpoints": {
            "created": 0,
            "deleted": 0
        },
        "webhookEvents": {
            "created": 0,
            "delivered": 0
        },
        "calls": {
            "powerDialer": {
                "answer": 0,
                "noAnswer": 0,
                "busy": 0,
                "callError": 0
            },
            "predictiveDialer": {
                "answer": 0,
                "noAnswer": 0,
                "busy": 0,
                "callError": 0
            },
            "progressiveDialer": {
                "agentAnswer": {
                    "numberConnected": 0,
                    "numberNotConnected": 0,
                    "numberConnectionUnknown": 0,
                    "numberNotCalled": 0
                },
                "agentNoAnswer": 0,
                "agentBusy": 0,
                "agentCallError": 0
            }
        }
    },
    "ttsUsage": {
        "monthlyPeriod": {
            "startAt": "2026-03-23T17:00:00",
            "endAt": "2026-04-23T17:00:00"
        },
        "maxChars": 1500000,
        "usedChars": 0,
        "isLimitReached": false,
        "usageDetails": []
    },
    "createdAt": "2026-03-23T17:27:13.137",
    "updatedAt": "2026-03-23T17:27:13.137"
}
Otros Temas
Panel
Configura la conexión a tu Central Telefónica
Crea tus Flujos de Llamadas
Campañas
Reportes
Detalles de la Cuenta
Administración de Usuarios
Mi Perfil
Notificaciones
Valores Predeterminados de las Campañas
Planes & Facturación
Grupos de Feriados
Listas de Contactos
Administración de Listas Negras
API Keys
Documentación API
Webhooks
Resolución de Problemas
Producto
Cómo Funciona
Funciones
Precios
Selector de Plan
Calculador de ROI
Casos de Estudio
Discador de Potencia 3CX
Discador Predictivo 3CX
Discador Progresivo 3CX
Discador de Potencia
Discador Predictivo
Discador Progresivo
Soluciones
Salud
Servicios Financieros
Bienes Raíces
Gobierno
Educación
Ventas y Telemarketing
Empresa
Sobre nosotros
Contactanos
Reservar Demo
Partners
Blog
Ayuda & Docs
Preguntas Frecuentes
Documentación
Soporte
Comunidad
Legal
Términos de Uso
Uso Aceptable
Política de Privacidad
Acuerdo de Partners
Política de Cookies
Créditos
SIP Caller
© 2026 Easy Caller LLC Todos los Derechos Reservados
LinkedinYou Tube
Trustpilot