Skip to content
Home » Octopush Gateway SMS API » Callbacks » Delivery Callback

Delivery Callback

This webhook will be called by octopush on an ongoing basis, each time an acknowledgement of receipt is received.

Query fields

NameTypeDescription
channel stringChannel of the delivery (‘sms’, ‘voice_sms’, ‘facebook’, ‘instagram’, ‘rcs’, ’email’, ‘whatsapp’, etc…)
message_idstringTicket of the original message
numberstringMobile number
statusstringAcknowledgement status
delivery_datestringDate of acknowledgment in format “Y-m-d H:i:s”
meta_dataobjectWill contain meta data for each channel.
pressed_keys_codestringIf channel is voice. Will contain the list of the keys that the recipient typed.
call_durationintegerIf channel is voice. Number of seconds of the call duration.
charged_durationintegerIf channel is voice. Number of seconds that was charged.

Possible values for the “status” field:

  • ACK
  • DELIVERED
  • NOT_DELIVERED
  • NOT_ALLOWED
  • UNKNOWN_DELIVERY
  • BAD_DESTINATION
  • BLACKLISTED_NUMBER
  • UNDEFINED

Simple example of a PHP recovery script

$content = json_decode($response); 

echo $content['message_id']; // sms_5fa275dbf21dc 
echo $content['number']; // +33600000000 
echo $content['status']; // DELIVERED 
echo $content['delivery_date']; // 2020-11-04 11:11:45