SMS
[ class tree: SMS ] [ index: SMS ] [ all elements ]
Packages:
SMS


Files:
Clickatell.php

Classes:
SMS_Clickatell

Class: SMS_Clickatell

Source Location: /Clickatell.php

Class Overview




PHP Interface into Clickatell API




Author(s):






        
          
      

Version:


    
  
  • $Id: Clickatell.php,v 1.21 2004/11/13 17:36:35 jacques Exp $
    • 




Copyright:


    
  
  • 2002-2004 Jacques Marneweck
    • 









Methods
























Class Details



[line 31]

PHP Interface into Clickatell API





Tags:





  

    access:  public
  

  

    version:  $Id: Clickatell.php,v 1.21 2004/11/13 17:36:35 jacques Exp $
  

  

    copyright:  2002-2004 Jacques Marneweck
  

  

    author:  Jacques Marneweck <jacques@php.net>
  










[ Top ]








Class Methods



  

	
	
method auth [line 141]

	

    

    

		mixed auth(
)
    

    


	
		Authenticate to the Clickatell API Server.





Tags:





  

    return:  true on sucess or PEAR_Error object
  

  

    since:  1.1
  

  

    access:  public
  










        
[ Top ]

  

  

	
	
method deletemsg [line 195]

	

    

    

		void deletemsg(
mixed
$apimsgid)
    

    


	
		Delete message queued by Clickatell which has not been passed  onto the SMSC.





Tags:





  

    see:  http://www.clickatell.com/downloads/Clickatell_http_2.2.2.pdf
  

  

    since:  1.14
  

  

    access:  public
  










        
[ Top ]

  

  

	
	
method getbalance [line 246]

	

    

    

		void getbalance(
)
    

    


	
		Query balance of remaining SMS credits





Tags:





  

    since:  1.9
  

  

    access:  public
  










        
[ Top ]

  

  

	
	
method getmsgcharge [line 295]

	

    

    

		void getmsgcharge(
string
$apimsgid)
    

    


	
		Determine the cost of the message which was sent





Tags:





  

    since:  1.20
  










        
Parameters:

    

    

          

        string  
        $apimsgid  
        api_msg_id
      

        

    


        
[ Top ]

  

  

	
	
method init [line 347]

	

    

    

		void init(
[mixed
$_params = array()])
    

    


	
		Initilaise the Clicaktell SMS Class





Tags:





  

    since:  1.9
  

  

    access:  public
  










        
[ Top ]

  

  

	
	
method ping [line 376]

	

    

    

		mixed ping(
)
    

    


	
		Keep our session to the Clickatell API Server valid.





Tags:





  

    return:  true on sucess or PEAR_Error object
  

  

    since:  1.1
  

  

    access:  public
  










        
[ Top ]

  

  

	
	
method querymsg [line 429]

	

    

    

		string querymsg(
string
$apimsgid)
    

    


	
		Query message status





Tags:





  

    return:  message status or PEAR_Error object
  

  

    since:  1.5
  

  

    access:  public
  










        
Parameters:

    

    

          

        string  
        $apimsgid  
        spimsgid generated by Clickatell API
      

        

    


        
[ Top ]

  

  

	
	
method sendmsg [line 481]

	

    

    

		mixed sendmsg(
array
$_msg)
    

    


	
		Send an SMS Message via the Clickatell API Server





Tags:





  

    return:  true on sucess or PEAR_Error object
  

  

    since:  1.2
  

  

    access:  public
  










        
Parameters:

    

    

          

        array  
        $_msg  
        database result set
      

        

    


        
[ Top ]

  






        

		    

		    Documentation generated on Tue, 24 May 2005 21:17:59 +0200 by phpDocumentor 1.3.0RC3