SIGN UP

Account's authentication

Methods(2)

Methods

Logon

Gets a temporary session ID (and a permanent 'api_key') to work with the API.

Parameters

Returns

  • result:

    string

    The temporary session ID.

  • account_email:

    string

    The account email.

  • account_id:

    number

    The account's ID.

  • balance:

    number

    The current user's money in the currency specified for the account. See the additional info in the UserInfoType section.

  • api_key:

    string

    The permanent account (or admin user) access ID.

  • account_name:

    string

    The account's name.

  • credit_limit:

    number

    Credit limit for the account. The value is in the currency specified for the account. It is zero by default.

  • frozen:

    boolean

    Is account blocked by VoxImplant admins or not.

  • api_address:

    string

    The preferred address for the http api requests.

Examples

request:

Logon by email.

https://api.voximplant.com/platform_api/Logon/?account_email=test%40mail.ru&account_password=1234567

response:

The brief account profile.

{
    "frozen": false,
    "result": "2ba0ea3ac39d4b349f97f86128cc7519",
    "api_key": "2ed5970e-4988-440a-95e8-3f8f8481287c",
    "balance": 100,
    "account_id": 1,
    "api_address": "api-server.voximplant.com",
    "account_name": "test",
    "credit_limit": 0,
    "account_email": "account@email.com"
}

Logout

Forgets the session ID.

Parameters

  • account_id:

    number

    The account's ID.

  • session_id:

    string

    The temporary session ID to delete.

Returns

  • result:

    number

    1

Examples

request:

Logout.

https://api.voximplant.com/platform_api/Logout/?account_id=1&session_id=f3b93c1f-7f35-4569-a8ee-b75e3f6387ca

response:

Success.

{
    "result": 1
}