Assinar eventos do discador

POST

/dialer/monitor/subscribe

Assina eventos de monitoração do discador, como alterações de estado de campanhas e status de discagem de contatos.

Requisição

Parâmetros Bodyapplication/json

Exemplo

{
    "subscription": {
        "id": 10,
        "agents": [
            "agent.one",
            "agent.two"
        ],
        "services": [
            "Campanha de Vendas",
            "Campanha de Retenção"
        ],
        "events": [
            "on_dialer_state_change",
            "on_dialer_contact_status"
        ],
        "channel_id": 5,
        "webhook": "https://example.com/webhook",
        "expires": 3600
    }
}

Códigos de solicitação

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/dialer/monitor/subscribe' \
--header 'Content-Type: application/json' \
--data-raw '{
    "subscription": {
        "id": 10,
        "agents": [
            "agent.one",
            "agent.two"
        ],
        "services": [
            "Campanha de Vendas",
            "Campanha de Retenção"
        ],
        "events": [
            "on_dialer_state_change",
            "on_dialer_contact_status"
        ],
        "channel_id": 5,
        "webhook": "https://example.com/webhook",
        "expires": 3600
    }
}'

Respostas

🟢200OK

application/json

Sucesso

Body

Exemplo

{
    "response": {
        "command": "subscribe",
        "id": 10,
        "status": "ok"
    }
}

🟠400Pedido inválido

Modificado em 2024-09-11 19:13:36

Próxima página

Cancelar assinatura de eventos