For the complete documentation index, see llms.txt. This page is also available as Markdown.

Webhooks

Receive the statuses of your voice campaigns

Please note

To receive statuses, you must set your callback URL (notifyUrl) in the API request

Retrieving answering machine drop statuses

After sending a campaign, VoicePartner lets you receive the statuses of your campaigns. For more information, contact us.

Example of a status sent via GET

notifyUrl?campaign_token=oiTCpIVk2jvIY3xcfg&campaign_id=NDA_20230111_00811&delivered_quantity=1&total_quantity=1

Retrieving voice SMS statuses

Example of a JSON response sent via POST

{
  "campaignId": "XHa7GXvhy6zkhQEf4HtHG",
  "status": "delivered",
  "additionnal_status": "VOICE_ANSWERED",
  "phoneNumber": "006.........",
  "sendAt": "2026-01-13 11:35:00",
  "doneAt": "2026-01-13 11:35:12",
  "duration": 6,
  //If an audio file was added to the request
  "audioFileComplementaire": {
    "status": "Deposit"
  }
}

status

pending: ``Awaiting status

delivered: the call was transmitted

undelivered: the call was not transmitted

additionnal_status

VOICE_ANSWERED: The call was answered

VOICE_NOT_ANSWERED: Call not answered

Last updated