SIP CallerSIP Caller
Sommario
    Overview
    🔐 Authentication
    How to Create an API Key
    Example Header
    🌐 Base URL
    👤 Roles & Permissions
    📌 Endpoints Overview
    👥 Partners
    List Associated Partners
    Request Example
    Response Example
    Create Associated Partner
    Request Body
    Request Example
    Response Example
    🧑‍💼 Customers
    List Customers
    Request Example
    Response Example
    Create Customer
    Request Body
    Request Example
    Response Example

Overview

The Partners REST API allows external systems to manage partners and customers programmatically within the SIP Caller ecosystem.

This API is designed for Distributors and Partners who need to automate onboarding and management tasks.

🔐 Authentication

All API requests require authentication using a Bearer Token.

How to Create an API Key

  1. Log in to the SIP Caller Partners Console
  2. Navigate to Settings > API Keys
  3. Create a new API key
  4. Copy the generated API key token

Example Header

Include the API key token in the Authorization header:

Authorization: Bearer YOUR_API_KEY_TOKEN

🌐 Base URL

Every request must be sent to the following base URL:

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

👤 Roles & Permissions

RolePermissions
PartnerReaderCan only get existing partners and customers
PartnerAdminCan get existing partners and customers, and create new ones

📌 Endpoints Overview

MethodEndpointDescriptionRole Required
GET/partnersList associated partnersPartnerReader (Distributor)
POST/partnersCreate associated partnerPartnerAdmin (Distributor)
GET/customersList customersPartnerReader (Partner / Distributor)
POST/customersCreate customerPartnerAdmin (Partner / Distributor)

👥 Partners

List Associated Partners

GET /partners

Returns all partners associated with the authenticated distributor.

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'

The request allows specifying filters, sorting and range:

  • The filter instruction can specify any of the following fields:
    • filter={"name":"Partner Name"}
    • filter={"countryIds_ovl":["us","ar"]}
    • filter={"code":"Partner Code"}
    • filter={"state":"Active"} – State: Active, SignedUp
    • filter={"level":["Basic","Certified","Premium"]} – Level: Basic, Certified, Premium
    • filter={"createdAt_gte":"2026-01-01"} – Suffixes gte, gt, lte, lt
  • The sort instruction can specify any of the following fields, both ascending (ASC) or descending (DESC):
    • name
    • countryName
    • code
    • state
    • level
    • createdAt

Response Example

[
    {
        "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"
    }
]

Create Associated Partner

POST /partners

Creates a new partner under the authenticated distributor.

Request Body

{
    "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
    }
}

Request Example

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'

Response Example

{
    "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"
}

🧑‍💼 Customers

List Customers

GET /customers

Returns all customers associated with the authenticated partner or distributor.

Request Example

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'

The request allows specifying filters, sorting and range:

  • The filter instruction can specify any of the following fields:
    • filter={"name":"Customer Name"}
    • filter={"countryId":["us","ar"]}
    • filter={"planId":"ent-4sc-y"} - The plan ID is built as follows: ess / pro / ent (for Essentials, Professional or Enterprise), followed by the number of simultaneous calls, and then a suffix for the billing cycle (m for monthly, y for yearly). For example: pro-8sc-m, ent-16sc-y, etc.
    • filter={"state":"Trialing"} – State: FreePlan, PartnerPlan, Trialing, TrialExpired, SubscriptionActive, SubscriptionPastDue, SubscriptionExpired, Closed, Suspended, Abandoned
    • filter={"createdAt_gte":"2026-01-01"} – Suffixes gte, gt, lte, lt
  • The sort instruction can specify any of the following fields, both ascending (ASC) or descending (DESC):
    • name
    • countryName
    • planName
    • createdAt

Response Example

[
    {
        "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"
    }
]

Create Customer

POST /customers

Creates a new customer under the authenticated partner or distributor.

Request Body

{
    "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"
}

Request Example

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'

The following fields are optional:

  • partnerId: this is the ID of the partner that will be associated with the new customer. If not provided, the system will automatically associate the customer with the partner of the authenticated user. This is useful for distributors who want to create customers already associated with a specific partner.
  • partnerMemberIdForCustomerSupport: this is the ID of a member of the partner that will be associated with the new customer for support purposes. If provided, this member will be able to access the customer's account in the SIP Caller Console to provide support.

Response Example

{
    "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"
}
Altri argomenti
Pannello di controllo
Configura la connessione al tuo sistema telefonico
Crea i tuoi flussi di chiamate
Campagne
Rapporti
Dettagli Account
Gestione Utenti
Il mio Profilo
Notifiche
Impostazioni Predefinite della Campagna
Piani e Fatturazione
Gruppi di Vacanza
Elenchi di Contatti
Gestione delle Liste Nere
API Keys
Documentazione API
Webhooks
Risoluzione dei Problemi
Prodotto
Come Funziona
Caratteristiche
Prezzi
Selettore del Piano
Calcolatore del ROI
Casi di studio
Dialer di Potenza 3CX
Dialer Predittivo 3CX
Dialer Progressivo 3CX
Dialer di Potenza
Dialer Predittivo
Dialer Progressivo
Soluzioni
Assistenza Sanitaria
Servizi Finanziari
Immobiliare
Governo
Istruzione
Vendite e Telemarketing
Azienda
Chi siamo
Contattaci
Prenota una Dimostrazione
Partner
Blog
Aiuto e Documentazione
Domande Frequenti
Documentazione
Supporto
Comunità
Legale
Termini di Utilizzo
Uso Accettabile
Politica sulla Riservatezza
Contratto di Partnership
Gestione dei Cookie
Crediti
SIP Caller
© 2026 Easy Caller LLC Tutti i diritti riservati
LinkedinYou Tube
Trustpilot