SIP Caller | Documentação da API de Parceiros

Visão Geral

A API REST de Parceiros permite que sistemas externos gerenciem parceiros e clientes de forma programática dentro do ecossistema do SIP Caller.

Esta API foi projetada para Distribuidores e Parceiros que precisam automatizar tarefas de integração e gerenciamento.

🔐 Autenticação

Todas as solicitações da API exigem autenticação usando um Bearer Token.

Como Criar uma Chave de API

Faça login no Console de Parceiros do SIP Caller
Navegue até Settings > API Keys
Crie uma nova chave de API
Copie o token da chave de API gerado

Exemplo de Cabeçalho

Inclua o token da chave de API no cabeçalho Authorization:

Authorization: Bearer YOUR_API_KEY_TOKEN

🌐 URL Base

Toda solicitação deve ser enviada para a seguinte URL base:

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

👤 Funções e Permissões

Função	Permissões
PartnerReader	Só pode consultar parceiros e clientes existentes
PartnerAdmin	Pode consultar parceiros e clientes existentes, e criar novos

📌 Visão Geral dos Endpoints

Método	Endpoint	Descrição	Função Necessária
GET	/partners	Lista os parceiros associados	PartnerReader (Distribuidor)
POST	/partners	Cria um parceiro associado	PartnerAdmin (Distribuidor)
GET	/customers	Lista os clientes	PartnerReader (Parceiro / Distribuidor)
POST	/customers	Cria um cliente	PartnerAdmin (Parceiro / Distribuidor)

👥 Parceiros

Listar Parceiros Associados

GET /partners

Retorna todos os parceiros associados ao distribuidor autenticado.

Exemplo de Solicitação

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'

A solicitação permite especificar filtros, ordenação e intervalo:

A instrução filter pode especificar qualquer um dos seguintes campos:
- filter={"name":"Partner Name"}
- filter={"countryIds_ovl":["us","ar"]}
- filter={"code":"Partner Code"}
- filter={"state":"Active"} – Estado: Active, SignedUp
- filter={"level":["Basic","Certified","Premium"]} – Nível: Basic, Certified, Premium
- filter={"createdAt_gte":"2026-01-01"} – Sufixos gte, gt, lte, lt
A instrução sort pode especificar qualquer um dos seguintes campos, tanto em ordem crescente (ASC) quanto decrescente (DESC):
- name
- countryName
- code
- state
- level
- createdAt

Exemplo de Resposta

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

Criar Parceiro Associado

POST /partners

Cria um novo parceiro sob o distribuidor autenticado.

Corpo da Solicitação

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

Exemplo de Solicitação

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'

Exemplo de Resposta

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

Retorna todos os clientes associados ao parceiro ou distribuidor autenticado.

Exemplo de Solicitação

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'

A solicitação permite especificar filtros, ordenação e intervalo:

A instrução filter pode especificar qualquer um dos seguintes campos:
- filter={"name":"Customer Name"}
- filter={"countryId":["us","ar"]}
- filter={"planId":"ent-4sc-y"} - O ID do plano é construído da seguinte forma: ess / pro / ent (para Essentials, Professional ou Enterprise), seguido pelo número de chamadas simultâneas, e depois um sufixo para o ciclo de faturamento (m para mensal, y para anual). Por exemplo: 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"} – Sufixos gte, gt, lte, lt
A instrução sort pode especificar qualquer um dos seguintes campos, tanto em ordem crescente (ASC) quanto decrescente (DESC):
- name
- countryName
- planName
- createdAt

Exemplo de Resposta

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

Criar Cliente

POST /customers

Cria um novo cliente sob o parceiro ou distribuidor autenticado.

Corpo da Solicitação

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

Exemplo de Solicitação

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'

Os seguintes campos são opcionais:

partnerId: este é o ID do parceiro que será associado ao novo cliente. Se não for fornecido, o sistema associará automaticamente o cliente ao parceiro do usuário autenticado. Isso é útil para distribuidores que desejam criar clientes já associados a um parceiro específico.
partnerMemberIdForCustomerSupport: este é o ID de um membro do parceiro que será associado ao novo cliente para fins de suporte. Se fornecido, este membro poderá acessar a conta do cliente no Console SIP Caller para prestar suporte.

Exemplo de Resposta

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

Índice

Visão Geral

🔐 Autenticação

Como Criar uma Chave de API

Exemplo de Cabeçalho

🌐 URL Base

👤 Funções e Permissões

📌 Visão Geral dos Endpoints

👥 Parceiros

Listar Parceiros Associados

Exemplo de Solicitação

Exemplo de Resposta

Criar Parceiro Associado

Corpo da Solicitação

Exemplo de Solicitação

Exemplo de Resposta

🧑‍💼 Clientes

Listar Clientes

Exemplo de Solicitação

Exemplo de Resposta

Criar Cliente

Corpo da Solicitação

Exemplo de Solicitação

Exemplo de Resposta

Outros Tópicos

Produto

Soluções

Empresa

Ajuda e Documentação

Jurídico