API CALL

From Xminder
Jump to: navigation, search

Xminder API CALL Documentation

Contents


Dial


Originates call.
Parameter Description Example
key

The access key to make a request to a module.

This key is provided by Xminder's administrators and it must NOT be published.

The default value for this parameter is NULL.

5d952f8293148969d4c87518e5524641
yourNumber Your phone number. First, this phone number ( yourNumber ) will be called, and then, after you answer, the destination phone number ( destNumber ) will be called. 0000000000
destNumber Destination phone number. 1111111111
Observations:
  1. The parameters key, yourNumber and destNumber are required parameters.
  2. The values of the parameters from the table above (column Example) are not valid.


Simple Example


URL: https://api.xminder.com/call.dial?key=5d955f8293148969d4b82518e5524646&yourNumber=0000000000&destNumber=1111111111

Success:
<response>
    <success>true</success>
</response>


Error:

<response>
    <success>false</success>
    <error>E_SOMETHING</error>
</response>



Description of the errors


General API errors


General API errors
Code Description
E_CREDIT_EXPIRED Credit expired.
E_DENIED_IP The request is not accepted from the client's IP. Please contact Xminder's administrators.
E_KEY_DISABLED The value of the parameter key used in the request has been disabled. Please contact Xminder's administrators.
E_KEY_EMPTY The parameter key is missing from the request.
E_KEY_INVALID The value of the parameter key is invalid.
E_METHOD_INVALID Request to a module that does not exist in API.
E_NO_CREDIT Insufficient credit.
E_INTERNAL_X Internal error. Please contact Xminder's administrators and give them complete information about the error (E_INTERNAL_143, E_INTERNAL_345 or other).


API CALL errors


API CALL errors
Code Description
E_CALL_PARAM_DEST_NUMBER The parameter destNumber is missing from the request.
E_CALL_PARAM_DEST_NUMBER_INVALID The value of the parameter destNumber must contain only digits. No space or other characters allowed.
E_CALL_PARAM_DEST_NUMBER_LENGTH Length of parameter destNumber is less then 10 characters.
E_CALL_PARAM_YOUR_NUMBER The parameter yourNumber is missing from the request.
E_CALL_PARAM_YOUR_NUMBER_INVALID The value of the parameter yourNumber must contain only digits. No space or other characters allowed.
E_CALL_PARAM_YOUR_NUMBER_LENGTH Length of parameter yourNumber is less then 10 characters.
E_CALL_UNAVAILABLE_LINES You have reached the maximum number of simultaneous calls accepted on your account.
E_CALL_INTERNAL_X Internal error of the module CALL. Please contact Xminder's administrators and give them complete information about the error (E_CALL_INTERNAL_121, E_CALL_INTERNAL_205 or other).



    ⇑ Top of page ⇐ Home    
Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox