Get Credit Limit: Difference between revisions

From Boxis.net API Docs
Jump to navigation Jump to search
Created page with "=SMS Function: getCreditLimit= With this command, you are able to get available credit. === Input params === === Output params === ==== Example in XML (Success) ==== <pre..."
 
No edit summary
Line 4: Line 4:


=== Input params ===
=== Input params ===
{|
|-
| - '''version'''::String::API version (e.g. '1.0')
|-
| - '''timestamp'''::String::Sequence of characters, denoting the date and time (e.g '1336553826')
|-
| - '''content'''::String::The message text. Content of one message is normally 160 characters per single
SMS or 70 in case of using at least one special character (polish characters are
considered to be special characters). The maximal message is set to 459 normal
characters or 201 if special chars are used and it is being sent as one block of 3
messages joined together and charged as three messages.
|-
| - '''flash'''::Boolean::0/1 (optional)
|-
| - '''fast'''::Boolean::0/1 (optional)
|-
| - '''schedule'''::Boolean::0/1 (optional)
|-
| - '''timesend'''::String Format 'YYYY-MM-DD HH:MM' (optional, when schedule is 1)
|-
|}
'version' => '1.0',
        'returntype' => 'json',
        'timestamp' => $timestamp,
        'username' => 'konrad@modulesgarden.com',
        'authcode' => md5($timestamp. 'BX3KwWU2SuqvoEWnjYmOibf'),
        'section' => 'sms',
        'action' => 'getCreditLimit', 


=== Output params ===
=== Output params ===

Revision as of 12:24, 9 May 2012

SMS Function: getCreditLimit

With this command, you are able to get available credit.

Input params

- version::String::API version (e.g. '1.0')
- timestamp::String::Sequence of characters, denoting the date and time (e.g '1336553826')
- content::String::The message text. Content of one message is normally 160 characters per single

SMS or 70 in case of using at least one special character (polish characters are considered to be special characters). The maximal message is set to 459 normal characters or 201 if special chars are used and it is being sent as one block of 3 messages joined together and charged as three messages.

- flash::Boolean::0/1 (optional)
- fast::Boolean::0/1 (optional)
- schedule::Boolean::0/1 (optional)
- timesend::String Format 'YYYY-MM-DD HH:MM' (optional, when schedule is 1)

'version' => '1.0',

       'returntype' => 'json',
       'timestamp' => $timestamp,
       'username' => 'konrad@modulesgarden.com',
       'authcode' => md5($timestamp. 'BX3KwWU2SuqvoEWnjYmOibf'),
       'section' => 'sms',
       'action' => 'getCreditLimit',  

Output params

Example in XML (Success)

<?xml version="1.0" encoding="UTF-8"?>
<return>
  <result>1</result>
  <resulttxt>success</resulttxt>
  <params>
    <credit>186</credit>
  </params>
  <timestamp>1336558351</timestamp>
</return>

Example in XML (Error)

<?xml version="1.0" encoding="UTF-8"?>
<return>
  <result>0</result>
  <resulttxt>error: {error description}</resulttxt>
  <timestamp>1335767184</timestamp>
</return>

Example in Json (Success)

{"result":"1",
 "resulttxt":"success",
 "params":{
   "sms_id":"133655724631563000002130"}
 "timestamp":1335777400}
Single Scheduled SMS
{"result":"1",
 "resulttxt":"success",
 "params":{
   "credit":"186"}
 "timestamp":1335777400}

Example in Json (Error)

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