Delivery status callback (sent by AppHive to your CallbackUrl)

POST https://webhook.example.com

AppHive will POST the final message status to the CallbackUrl supplied on submission. Clients must return 200 OK to acknowledge receipt.

application/json

Body Required

  • ClientReference string Required

    Client-defined reference supplied during message submission

  • Ticket string(uuid) Required

    Unique AppHive transaction identifier

  • Destination string Required

    Recipient MSISDN (E.164 without '+')

  • Cost number(float) Required

    Cost charged for the message (wallet currency)

  • BalanceBefore number(float) Required

    Wallet balance before charging

  • BalanceAfter number(float) Required

    Wallet balance after charging

  • Status string Required

    Final delivery status of the message

Responses

  • 200

    Callback received

  • 400

    Invalid payload

  • 500

    Client server error

POST smsDeliveryCallback
Request example 
{
  "Cost": 150,
  "Status": "success",
  "Ticket": "5f6f9a96-d766-4787-ba08-1fa0939b7166",
  "Destination": "23230588654",
  "BalanceAfter": 9850,
  "BalanceBefore": 10000,
  "ClientReference": "my_reference_1"
}