Register
 
Login
 
Buttons
Call.To API documentation

The Call.To API requires an API key. To get your API key register here


    Create a login session for a user on the Call.To server. Returns the user details and Call.To session id.
Requires loginNO
Parameters user
password - in base64_encoded()-ed form
Example $callTo->login(
   array(
     'user'=>$user,
     'password'=>base64_encode($password)
   )
);
 

    Check if an user is available or already registered
Requires loginYES
Parameters user
Example $callTo->check_user(
   array(
     'user'=>$user
   )
);
 

    Check if an email is available or already linked to another account
Requires loginYES
Parameters email
Example $callTo->check_email(
   array(
     'email'=>$email
   )
);
 

    Check if an alias is available or has already been registered
Requires loginYES
Parameters alias
Example $callTo->check_alias(
   array(
     'alias'=>$alias
   )
);
 

    Register a new user in the Call.To system. Does NOT create an alias for the user
Requires loginYES
Parameters user
password - in base64_encoded()-ed form
email
birth_date
name
sex
Example $callTo->register_user(
   array(
     'user'=>$user,
     'password'=>base64_encode($password),
     'email'=>$email,
     'birth_date'=>$birth_date,
     'name'=>$name,
     'sex'=>$sex
   )
);
 

    Register a new alias for an existing Call.To user
Requires loginYES
Parameters user_id
alias
Example $callTo->register_alias(
   array(
     'user_id'=>$user_id,
     'alias'=>$alias
   )
);
 

    Move cash from the logged-in user`s account to another user
Requires loginYES
Parameters user
amount
Example $callTo->move_cash(
   array(
     'user'=>$user,
     'amount'=>$amount
   )
);
 

    Get the available cash for the logged-in user
Requires loginYES
Parameters -
Example $callTo->get_cash(false);
 

    Get the defined aliases of the logged-in user
Requires loginYES
Parameters -
Example $callTo->get_aliases(false);
 

    Get the call history for a certain alias
Requires loginYES
Parameters alias
page
Example $callTo->get_history(
   array(
     'alias'=>$alias,
     'page'=>$page
   )
);
 

    Validate a phone number for an alias of the logged-in user
Requires loginYES
Parameters alias
phone
Example $callTo->validate_phone(
   array(
     'alias'=>$alias,
     'phone'=>$phone
   )
);
 

    Get available area codes for buying local phone numbers
Requires loginYES
Parameters -
Example $callTo->get_areacodes(false);
 

    Buy a tollfree number
Requires loginYES
Parameters -
Example $callTo->buy_tollfree_number(false);
 

    Buy a local number in a speciffied areacode
Requires loginYES
Parameters areacode
Example $callTo->buy_local_number(
   array(
     'areacode'=>$areacode
   )
);
 

    Forward a bought phone number to a Call.To alias
Requires loginYES
Parameters number_id
alias
Example $callTo->forward_to_alias(
   array(
     'number_id'=>$number_id,
     'alias'=>$alias
   )
);
 

    Forward a bought phone number to an external phone
Requires loginYES
Parameters number_id
country_code
phone
Example $callTo->forward_to_phone(
   array(
     'number_id'=>$number_id,
     'country_code'=>$country_code,
     'phone'=>$phone
   )
);
 

    Forward a bought phone number directly to the Call.To voicemail service
Requires loginYES
Parameters number_id
Example $callTo->forward_to_voicemail(
   array(
     'number_id'=>$number_id
   )
);
 

    Get a list of the phone numers that have bought by the current user
Requires loginYES
Parameters -
Example $callTo->get_forwarding_numbers(false);
 

    Get details about a phone number bought by the current user
Requires loginYES
Parameters number_id
Example $callTo->get_forwarding_number(
   array(
     'number_id'=>$number_id
   )
);
 

    Enable the forwarding of calls for a speciffic phone number
Requires loginYES
Parameters number_id
Example $callTo->enable_forwarding_number(
   array(
     'number_id'=>$number_id
   )
);
 

    Disable the forwarding of calls for a speciffic phone number
Requires loginYES
Parameters number_id
Example $callTo->disable_forwarding_number(
   array(
     'number_id'=>$number_id
   )
);
 

    Delete a forwarding phone number and stop rebilling for it
Requires loginYES
Parameters number_id
Example $callTo->delete_forwarding_number(
   array(
     'number_id'=>$number_id
   )
);
 

    Get the costs associated with forwarding calls, both per month and per minute
Requires loginYES
Parameters -
Example $callTo->get_forwarding_costs(false);
 

    Get the list of voicemail messages for a speciffic phone number
Requires loginYES
Parameters number_id
page
Example $callTo->get_forwarding_voicemails(
   array(
     'number_id'=>$number_id,
     'page'=>$page
   )
);
 

    Get the MP3 for a certain voicemail message
Requires loginYES
Parameters voicemail_id
Example $callTo->get_forwarding_voicemail(
   array(
     'voicemail_id'=>$voicemail_id
   )
);

Download API client