API Ping
Overview
Calling the ping command will keep your session ID active for another 15 minutes (unless it has already expired).
This command is only useful if you are using the Authentication command to get a session ID for authenticating your API requests. Session IDs expire after 15 minutes of inactivity (if no API request is made with the session ID for 15 minutes).
Note: any API command using a session ID will cause your session ID to remain active for another 15 minutes.
You can call this API command once every 10 minutes or so to keep your session active. Should your session expire, your application needs to make a new authentication request to get a new session ID.
Command
https: //api.clickatell.com/http/ping?session_id=xxxxxxxxxxxx_ |
Parameters
For this call you do not send through the usual authentication parameters. You will only send through the following parameter:
Parameter |
Description |
---|---|
|
Your session ID |
Examples
Bash
session_id= "place session ID here" curl --data "session_id=$session_id" \ 'https://api.clickatell.com/http/ping' |
PHP
1 |
|
Python
1 |
|
API responses
Example response
Successful API response:
OK: f6b9af2a2c9e5b18ee2d257e3def5d66 |
Error response:
ERR: 001 , Authentication failed |
Format
Successful API response:
OK: <session ID> |
Error response:
ERR: <error code>, <error description> |
Submit a Comment
Other Resources
Ask the Community
Visit Stack Overflow to join our community of developers and find the answer you need
Contact Support
Contact our support team and one of our agents will be in touch with you to answer any questions you have