+41 58 018 00 00

contact our sales to get a custom offer!

Knowledgebase

Delete Scheduled SMS

SMS Functions - Delete Scheduled SMS

Delete Scheduled SMS

 

Contents

SMS Function: deleteScheduledSMS

With this command, you are able to delete sms from scheduled list

 

Input params

  • version::String - API version (e.g. '1.0')
  • timestamp::String - Sequence of characters, denoting the date and time (e.g '1336553826')
  • username::String - User e-mail address (e.g 'mail1@example.com')
  • authcode::String - md5 hash consisting of the concatenation of timestamp and user_key (e.g md5(1336553826BX3KwWU2SuqvoEWnjYmOibf'))
  • section::String - API module name. Use 'sms' value
  • action::String - API module function. Use 'deleteScheduledSMS' value
  • sms_id::String - Identifier that is returned by the function send_sms

 

Example URL with POST values

http://api.boxis.net/
POST: version=1.0&returntype=xml&timestamp=1337853607&username=your@mail.com&authcode=1234567890&action=sms&action=deleteScheduledSMS&sms_id=133708185509553000014220

Output params

Example in XML (Success)



  1
  success
  
  1336558351

Example in XML (Error)



  0
  error: {error description}
  1335767184

Example in JSON (Success)

{"result":"1",
 "resulttxt":"success",
 "params":[]
 "timestamp":1335777400}

Example in JSON (Error)

{"result":"0",
 "resulttxt":"Error: {error description}",
 "timestamp":1335777400}

 

Example using our PHP Class

/* API LOGIN DETAILS */
$email    = 'your@mail.com';    // your username
$apikey   = '1234567890';        // your apikey

/* API COMMAND DETAILS */
$apitype  = 'sms';
$command  = 'deleteScheduledSMS';
$params   = array(
    'returntype' => 'xml',
    'sms_id' => '133708185509553000014220'
);

/* PROCESS THE ACTION */
$boxisAPI = new BoxisAPIConnection($email, $apikey);
$return = $boxisAPI->call($apitype, $command, $params, $timestamp);

/* TIMESTAMP SYNCHRONIZATION (JSON EXAMPLE)
if($return['timestamperror']) {
    $timestamp = $return['timestamp'];
    $return = $boxisAPI->call($apitype, $command, $params, 'json', $timestamp);
}
*/

/* TIMESTAMP SYNCHRONIZATION (XML EXAMPLE)*/
/*
if($return->timestamperror) {
    $timestamp = $return->timestamp;
    $return = $boxisAPI->call($apitype, $command, $params, 'xml', $timestamp);
}
/*

Get Support From Real People

When you are stuck in something don’t waste your time just let us know we are here to help you

Contact Us

If you have question which is beyond this knowledgebase Kindly contact us