Account Calls
Info! Do you have any questions on our Email API?
Write to us at support@sendclean.com
/account/viewUserDetail
view User Details
<?php
try {
require_once 'SendCleanMTA_PHP/SendClean.php';
$SendClean= new SendClean('owner_id', 'token', 'SendCleanTES_APP_DOMAIN');
$result = $SendClean->accounts->viewUserDetail();
print_r($result);
/*
Array
(
[status] => "success"
[user_data] => array(
[name] => "john yu"
[email] => "john@SendClean.com"
[mobile] => 9999999999
[create_date] => 67457775764
[allowed_speed] => 300
[reputation] => "50%"
)
)
*/
} catch(SendClean_Error $e) {
// SendCleanerrors are thrown as exceptions
echo "A SendCleanerror occurred: " . get_class($e) . " - " . $e->getMessage();
}
?>
Array
(
[status] => "success"
[user_data] => array(
[name] => "john yu"
[email] => "john@SendClean.com"
[mobile] => 9999999999
[create_date] => 67457775764
[allowed_speed] => 300
[reputation] => "50%"
)
)
Array
(
[status]=> "error"
[code]=> -1
[name]=> "AuthenticationError"
[message]=> "Token MissMatch"
)
Parameters |
owner_id* string |
a valid SendCleanUser Id |
token* string |
a valid token |
SendCleanTES_APP_DOMAIN* string |
a valid SendCleanTES APP DOMAIN |
* compulsory field
Return Value: Success |
struct |
the results of User Details
status string |
always success |
user_data[]struct |
information of user details
name string |
user's name |
email string |
user's email |
mobile string |
user's mobile no. |
allowed_speed integer |
user's allowed speed |
reputation string |
user's reputation in % |
create_date integer |
create date in seconds |
|
|
|
|
Return Value: Error |
struct |
the error results when attempt to get User Details
status string |
error |
message string |
human readable message |
type string |
one of the error type as bellow table |
|
|
Error types |
ValidationError |
The parameters passed to the API call are invalid or not provided when required. |
GeneralError |
An unexpected errors occurred processing the request. SendCleanDevelopers will be notified. |
AuthenticationError |
Provided owner_id and token was not matched. |