SIP Caller | Riferimento Dati dei Webhook

Sommario

Campagna Attivata

Campagna Messa in Pausa

Campagna Ripresa

Campagna Annullata

Campagna Terminata

Chiamata Terminata

Riferimento Dati dei Webhook

I webhook generati da SIP Caller sono richieste HTTP POST, contenenti JSON come payload. Il dettaglio dei dati JSON inviati per ciascun evento è descritto di seguito. Usa il selettore di versione per vedere il formato del payload della versione di webhook che hai configurato.

Torna alla documentazione sui Webhook

Versione

Campagna Attivata

{
  "id": "01928321-9129-7f25-8ad3-80c57b16d3ed",
  "object": "event",
  "apiVersion": 2,
  "createdAt": "2024-10-12T23:47:48.133",
  "type": "CampaignActivated",
  "data": {
    "customer": {
      "id": "0192830c-58a0-7be2-8e3d-dc8997d0a631",
      "name": "SIP Caller (Demo account)"
    },
    "campaign": {
      "id": "0192831a-fbbe-735f-b385-a3252781817d",
      "name": "Campaign 1",
      "phoneSystem": {
        "id": "01928310-2d96-7a70-bdfc-4bcd24c22c95",
        "name": "My Phone System",
        "extension": {
          "id": "07bcd1de-1e5d-47b5-99bf-b846c7a12f09",
          "name": "SIP Caller Extension"
        }
      },
      "dialer": {
        "mode": "Power"
      },
      "state": "Active",
      "numberProvisioning": "Static",
      "numberSelection": "Fifo",
      "numberPriority": "RetryPending",
      "startDate": "2024-10-12",
      "endDate": null,
      "timeZoneId": "America/Argentina/Buenos_Aires",
      "callHandling": {
        "$t": "Callflow",
        "answerTypeDetector": {
          "$t": "AmdAgent",
          "amdAgent": {
            "id": "019f8f68-f2d9-7ae9-9e8c-790ee1c1413a",
            "name": "Voicemail Detector AI Agent"
          },
          "unknownAnswerTreatment": "Human",
          "messageForVoicemail": {
            "$t": "OnFirstDetection",
            "callflow": {
              "id": "019f8c61-daf6-762d-b23a-a0199de9cba3",
              "name": "Leave voicemail"
            },
            "isCallRetryEnabled": true
          }
        },
        "callflow": {
          "id": "019f944f-d5ab-717e-a36f-06097fe6be3c",
          "name": "Survey"
        },
        "ttsVoiceId": "azu-es-AR-ElenaNeural"
      },
      "varNames": [
        "Customer Name",
        "Due Balance"
      ],
      "startedAt": null,
      "endedAt": null
    },
    "origin": {
      "user": {
        "id": "0192830c-589d-7384-b157-f922afab9e55",
        "name": "John Doe",
        "email": "john.doe@example.com"
      },
      "ipAddress": "98.97.134.180"
    }
  }
}

Valori possibili per gli enum utilizzati nel JSON sopra:

Stato della campagna: "Draft", "Active", "Paused", "Finished", "Canceled"
Modalità dialer: "Power", "Predictive", "Progressive"
Provisioning del numero: "Static", "Dynamic"
Selezione numero: "Fifo", "Lifo"
Priorità numero: "RetryPending", "NotContacted"
Tipi di gestione chiamata: "Callflow", "AiAgent"
Rilevatori di tipo di risposta: "Disabled", "Standard", "AmdAgent"
Tipi di trattamento risposta sconosciuta: "Human", "Voicemail"
Tipi di messaggio per segreteria: "Never", "OnFirstDetection", "OnLastAttempt", "OnEveryAttempt"

Campagna Messa in Pausa

{
  "id": "01928323-1fcd-721d-ad19-8ce4cfc1c135",
  "object": "event",
  "apiVersion": 2,
  "createdAt": "2024-10-12T23:49:30.185",
  "type": "CampaignPaused",
  "data": {
    "customer": {
      "id": "0192830c-58a0-7be2-8e3d-dc8997d0a631",
      "name": "SIP Caller (Demo account)"
    },
    "campaign": {
      "id": "0192831a-fbbe-735f-b385-a3252781817d",
      "name": "Campaign 1",
      "phoneSystem": {
        "id": "01928310-2d96-7a70-bdfc-4bcd24c22c95",
        "name": "My Phone System",
        "extension": {
          "id": "07bcd1de-1e5d-47b5-99bf-b846c7a12f09",
          "name": "SIP Caller Extension"
        }
      },
      "dialer": {
        "mode": "Power"
      },
      "state": "Paused",
      "numberProvisioning": "Static",
      "numberSelection": "Fifo",
      "numberPriority": "RetryPending",
      "startDate": "2024-10-12",
      "endDate": "2024-10-13",
      "timeZoneId": "America/Argentina/Buenos_Aires",
      "callHandling": {
        "$t": "Callflow",
        "answerTypeDetector": {
          "$t": "AmdAgent",
          "amdAgent": {
            "id": "019f8f68-f2d9-7ae9-9e8c-790ee1c1413a",
            "name": "Voicemail Detector AI Agent"
          },
          "unknownAnswerTreatment": "Human",
          "messageForVoicemail": {
            "$t": "OnFirstDetection",
            "callflow": {
              "id": "019f8c61-daf6-762d-b23a-a0199de9cba3",
              "name": "Leave voicemail"
            },
            "isCallRetryEnabled": true
          }
        },
        "callflow": {
          "id": "019f944f-d5ab-717e-a36f-06097fe6be3c",
          "name": "Survey"
        },
        "ttsVoiceId": "azu-es-AR-ElenaNeural"
      },
      "varNames": [
        "Customer Name",
        "Due Balance"
      ],
      "startedAt": "2024-10-12T23:48:05.603",
      "endedAt": null
    },
    "origin": {
      "user": {
        "id": "0192830c-589d-7384-b157-f922afab9e55",
        "name": "John Doe",
        "email": "john.doe@example.com"
      },
      "ipAddress": "98.97.134.180"
    }
  }
}

Valori possibili per gli enum utilizzati nel JSON sopra:

Stato della campagna: "Draft", "Active", "Paused", "Finished", "Canceled"
Modalità dialer: "Power", "Predictive", "Progressive"
Provisioning del numero: "Static", "Dynamic"
Selezione numero: "Fifo", "Lifo"
Priorità numero: "RetryPending", "NotContacted"
Tipi di gestione chiamata: "Callflow", "AiAgent"
Rilevatori di tipo di risposta: "Disabled", "Standard", "AmdAgent"
Tipi di trattamento risposta sconosciuta: "Human", "Voicemail"
Tipi di messaggio per segreteria: "Never", "OnFirstDetection", "OnLastAttempt", "OnEveryAttempt"

Campagna Ripresa

{
  "id": "01928329-e0ae-767b-831c-eb534f0ca3ce",
  "object": "event",
  "apiVersion": 2,
  "createdAt": "2024-10-12T23:56:52.78",
  "type": "CampaignResumed",
  "data": {
    "customer": {
      "id": "0192830c-58a0-7be2-8e3d-dc8997d0a631",
      "name": "SIP Caller (Demo account)"
    },
    "campaign": {
      "id": "0192831a-fbbe-735f-b385-a3252781817d",
      "name": "Campaign 1",
      "phoneSystem": {
        "id": "01928310-2d96-7a70-bdfc-4bcd24c22c95",
        "name": "My Phone System",
        "extension": {
          "id": "07bcd1de-1e5d-47b5-99bf-b846c7a12f09",
          "name": "SIP Caller Extension"
        }
      },
      "dialer": {
        "mode": "Power"
      },
      "state": "Active",
      "numberProvisioning": "Static",
      "numberSelection": "Fifo",
      "numberPriority": "RetryPending",
      "startDate": "2024-10-12",
      "endDate": "2024-10-13",
      "timeZoneId": "America/Argentina/Buenos_Aires",
      "callHandling": {
        "$t": "Callflow",
        "answerTypeDetector": {
          "$t": "AmdAgent",
          "amdAgent": {
            "id": "019f8f68-f2d9-7ae9-9e8c-790ee1c1413a",
            "name": "Voicemail Detector AI Agent"
          },
          "unknownAnswerTreatment": "Human",
          "messageForVoicemail": {
            "$t": "OnFirstDetection",
            "callflow": {
              "id": "019f8c61-daf6-762d-b23a-a0199de9cba3",
              "name": "Leave voicemail"
            },
            "isCallRetryEnabled": true
          }
        },
        "callflow": {
          "id": "019f944f-d5ab-717e-a36f-06097fe6be3c",
          "name": "Survey"
        },
        "ttsVoiceId": "azu-es-AR-ElenaNeural"
      },
      "varNames": [
        "Customer Name",
        "Due Balance"
      ],
      "startedAt": "2024-10-12T23:48:05.603",
      "endedAt": null
    },
    "origin": {
      "user": {
        "id": "0192830c-589d-7384-b157-f922afab9e55",
        "name": "John Doe",
        "email": "john.doe@example.com"
      },
      "ipAddress": "98.97.134.180"
    }
  }
}

Valori possibili per gli enum utilizzati nel JSON sopra:

Stato della campagna: "Draft", "Active", "Paused", "Finished", "Canceled"
Modalità dialer: "Power", "Predictive", "Progressive"
Provisioning del numero: "Static", "Dynamic"
Selezione numero: "Fifo", "Lifo"
Priorità numero: "RetryPending", "NotContacted"
Tipi di gestione chiamata: "Callflow", "AiAgent"
Rilevatori di tipo di risposta: "Disabled", "Standard", "AmdAgent"
Tipi di trattamento risposta sconosciuta: "Human", "Voicemail"
Tipi di messaggio per segreteria: "Never", "OnFirstDetection", "OnLastAttempt", "OnEveryAttempt"

Campagna Annullata

{
  "id": "01928761-9826-7ca4-9283-eb6f7a338c91",
  "object": "event",
  "apiVersion": 2,
  "createdAt": "2024-10-13T19:36:13.093",
  "type": "CampaignCanceled",
  "data": {
    "customer": {
      "id": "0192830c-58a0-7be2-8e3d-dc8997d0a631",
      "name": "SIP Caller (Demo account)"
    },
    "campaign": {
      "id": "01928761-27c6-7355-9add-0c4f40154847",
      "name": "Campaign 1",
      "phoneSystem": {
        "id": "01928310-2d96-7a70-bdfc-4bcd24c22c95",
        "name": "My Phone System",
        "extension": {
          "id": "07bcd1de-1e5d-47b5-99bf-b846c7a12f09",
          "name": "SIP Caller Extension"
        }
      },
      "dialer": {
        "mode": "Power"
      },
      "state": "Canceled",
      "numberProvisioning": "Static",
      "numberSelection": "Fifo",
      "numberPriority": "RetryPending",
      "startDate": "2024-10-13",
      "endDate": "2024-10-13",
      "timeZoneId": "America/Argentina/Buenos_Aires",
      "callHandling": {
        "$t": "Callflow",
        "answerTypeDetector": {
          "$t": "AmdAgent",
          "amdAgent": {
            "id": "019f8f68-f2d9-7ae9-9e8c-790ee1c1413a",
            "name": "Voicemail Detector AI Agent"
          },
          "unknownAnswerTreatment": "Human",
          "messageForVoicemail": {
            "$t": "OnFirstDetection",
            "callflow": {
              "id": "019f8c61-daf6-762d-b23a-a0199de9cba3",
              "name": "Leave voicemail"
            },
            "isCallRetryEnabled": true
          }
        },
        "callflow": {
          "id": "019f944f-d5ab-717e-a36f-06097fe6be3c",
          "name": "Survey"
        },
        "ttsVoiceId": "azu-es-AR-ElenaNeural"
      },
      "varNames": [
        "Customer Name",
        "Due Balance"
      ],
      "startedAt": null,
      "endedAt": "2024-10-13T19:36:13.093"
    },
    "origin": {
      "user": {
        "id": "0192830c-589d-7384-b157-f922afab9e55",
        "name": "John Doe",
        "email": "john.doe@example.com"
      },
      "ipAddress": "98.97.134.223"
    }
  }
}

Valori possibili per gli enum utilizzati nel JSON sopra:

Stato della campagna: "Draft", "Active", "Paused", "Finished", "Canceled"
Modalità dialer: "Power", "Predictive", "Progressive"
Provisioning del numero: "Static", "Dynamic"
Selezione numero: "Fifo", "Lifo"
Priorità numero: "RetryPending", "NotContacted"
Tipi di gestione chiamata: "Callflow", "AiAgent"
Rilevatori di tipo di risposta: "Disabled", "Standard", "AmdAgent"
Tipi di trattamento risposta sconosciuta: "Human", "Voicemail"
Tipi di messaggio per segreteria: "Never", "OnFirstDetection", "OnLastAttempt", "OnEveryAttempt"

Campagna Terminata

{
  "id": "01928735-88af-7fc5-ae74-81ff77bf6e61",
  "object": "event",
  "apiVersion": 2,
  "createdAt": "2024-10-13T18:48:05.526",
  "type": "CampaignFinished",
  "data": {
    "customer": {
      "id": "0192830c-58a0-7be2-8e3d-dc8997d0a631",
      "name": "SIP Caller (Demo account)"
    },
    "campaign": {
      "id": "0192831a-fbbe-735f-b385-a3252781817d",
      "name": "Campaign 1",
      "phoneSystem": {
        "id": "01928310-2d96-7a70-bdfc-4bcd24c22c95",
        "name": "My Phone System",
        "extension": {
          "id": "07bcd1de-1e5d-47b5-99bf-b846c7a12f09",
          "name": "SIP Caller Extension"
        }
      },
      "dialer": {
        "mode": "Power"
      },
      "state": "Finished",
      "numberProvisioning": "Static",
      "numberSelection": "Fifo",
      "numberPriority": "RetryPending",
      "startDate": "2024-10-12",
      "endDate": "2024-10-13",
      "timeZoneId": "America/Argentina/Buenos_Aires",
      "callHandling": {
        "$t": "Callflow",
        "answerTypeDetector": {
          "$t": "AmdAgent",
          "amdAgent": {
            "id": "019f8f68-f2d9-7ae9-9e8c-790ee1c1413a",
            "name": "Voicemail Detector AI Agent"
          },
          "unknownAnswerTreatment": "Human",
          "messageForVoicemail": {
            "$t": "OnFirstDetection",
            "callflow": {
              "id": "019f8c61-daf6-762d-b23a-a0199de9cba3",
              "name": "Leave voicemail"
            },
            "isCallRetryEnabled": true
          }
        },
        "callflow": {
          "id": "019f944f-d5ab-717e-a36f-06097fe6be3c",
          "name": "Survey"
        },
        "ttsVoiceId": "azu-es-AR-ElenaNeural"
      },
      "varNames": [
        "Customer Name",
        "Due Balance"
      ],
      "startedAt": "2024-10-12T23:48:05.603",
      "endedAt": "2024-10-13T18:48:05.526"
    },
    "origin": null
  }
}

Valori possibili per gli enum utilizzati nel JSON sopra:

Stato della campagna: "Draft", "Active", "Paused", "Finished", "Canceled"
Modalità dialer: "Power", "Predictive", "Progressive"
Provisioning del numero: "Static", "Dynamic"
Selezione numero: "Fifo", "Lifo"
Priorità numero: "RetryPending", "NotContacted"
Tipi di gestione chiamata: "Callflow", "AiAgent"
Rilevatori di tipo di risposta: "Disabled", "Standard", "AmdAgent"
Tipi di trattamento risposta sconosciuta: "Human", "Voicemail"
Tipi di messaggio per segreteria: "Never", "OnFirstDetection", "OnLastAttempt", "OnEveryAttempt"

Chiamata Terminata

{
  "id": "01928322-860c-77f9-9c3b-7f8abe3b6afd",
  "object": "event",
  "apiVersion": 2,
  "createdAt": "2024-10-12T23:48:50.824",
  "type": "CallEnded",
  "data": {
    "customer": {
      "id": "0192830c-58a0-7be2-8e3d-dc8997d0a631",
      "name": "SIP Caller (Demo account)"
    },
    "campaign": {
      "id": "0192831a-fbbe-735f-b385-a3252781817d",
      "name": "Campaign 1",
      "varNames": [
        "Customer Name",
        "Due Balance"
      ]
    },
    "callDetails": {
      "callId": "01928322-32a3-7000-bf0d-bf1af7eda4c5",
      "numberId": 1048165,
      "prefix": "",
      "number": "18035551004",
      "calledNumber": "18035551004",
      "varValues": [
        "Stefan Robertson",
        "$99.00 "
      ],
      "attempt": 1,
      "addedAt": "2024-10-12T10:05:23.452",
      "phoneSystem": {
        "id": "01928310-2d96-7a70-bdfc-4bcd24c22c95",
        "name": "My Phone System",
        "extension": {
          "id": "07bcd1de-1e5d-47b5-99bf-b846c7a12f09",
          "name": "SIP Caller Extension"
        }
      },
      "queueId": "800",
      "agentId": "101",
      "timeZoneId": "America/Argentina/Buenos_Aires",
      "startedAt": "2024-10-12T23:48:29.479",
      "ringResult": "Answer",
      "sipResponse": {
        "code": 200,
        "descrip": "OK"
      },
      "answeredAt": "2024-10-12T23:48:33.735",
      "answerType": "Human",
      "answerMessage": null,
      "voicemailLeft": false,
      "callflow": {
        "id": "01928316-cfd7-75c7-bb6d-9128e205c53f",
        "name": "Survey"
      },
      "endedAt": "2024-10-12T23:48:50.819",
      "endType": "CallflowComplete",
      "lastAction": {
        "id": "535248e9-c9a2-4a15-8c1c-9d175f82ac21",
        "type": "TextPrompt"
      },
      "duration": {
        "setup": "00:00:04.256",
        "connected": "00:00:17.084",
        "total": "00:00:21.34"
      },
      "interactionResults": [
        {
          "id": "a6d5b2e5-6b3f-49d8-aaa3-bc7b4c693f05",
          "type": "DtmfInput",
          "label": "Question 1",
          "value": "1"
        },
        {
          "id": "af5fd8d6-2ed4-4546-bb50-1b4214b71f7a",
          "type": "DtmfInput",
          "label": "Question 2",
          "value": "2"
        }
      ],
      "transfer": {
        "duration": "00:00:51.877",
        "result": "NotConnected",
        "connectedAt": null
      },
      "agent": {
        "releasedAt": "2025-09-17T21:00:25.94",
        "duration": {
          "setup": "00:00:58.716",
          "connected": "00:00:00",
          "total": "00:00:58.716"
        }
      },
      "outcome": "Success",
      "retryAt": null
    }
  }
}

Valori possibili per gli enum utilizzati nel JSON sopra:

Risultato squillo: "Answer", "Busy", "NoAnswer", "CallError"
Tipo di risposta: "Human", "Machine", "Voicemail", "Message", "Unknown"
Tipo di terminazione: "HangUp", "CallflowComplete", "ExecutionError"
Tipo di ultima azione: "TransferCall", "TextPrompt", "WavPrompt", "DtmfInput", "DropCall"
Risultato del trasferimento: "Connected", "NotConnected"
Esito: "Success", "FailureWithNoRetryLeft", "FailureWithRetryPending"