Developers

TheInterviewr has a REST API available for integration of our service into your apps.

Getting Started

You can access the API by using the following URL:

http://api.theinterviewr.com/?action=ThefunctionName&variable1=something&Variable2=something+else

Where Function Name is the function in the list below, and the variables are the variables required to be passed below.

Note: Before doing any other actions, you will need to perform a login, or have a user’s unique token, as all other functions require a user token to do anything.


Functions and what they do

Function Name Variables Passed Returns
Login
Array
(
    [username] => String
    [password] => String
    [format] => json
)
Array
(
    [data] => Array
        (
            [token] => Alphanumeric
        )

    [result] => 1 or 0
)
GetUserInfo
Array
(
    [token] => String
    [format] => json
)
Array
(
    [data] => Array
        (
            [0] => ID
            [1] => user_login
            [2] => user_nicename
            [3] => user_email
            [4] => user_url
            [5] => user_registered
            [6] => user_status
            [7] => display_name
            [8] => user_token
            [9] => timezone
            [10] => balance
        )

    [result] => 1 or 0
)
GetInterviews
Array
(
    [token] => String
    [archived] => Int (1 or 0)
    [format] => json
)
Array
(
    [data] => Array
        (
            [item] => Array
                (
                    [0] => ID
                    [1] => user_id
                    [2] => interview_date
                    [3] => interview_gmdate
                    [4] => interview_name
                    [5] => interview_contact_phone
                    [6] => interview_your_phone
                    [7] => interview_meta
                    [8] => interview_notes
                    [9] => interview_archived
                    [10] => casid
                    [recording] => Array
                        (
                            [0] => casid
                            [1] => duration
                            [2] => date
                            [3] => file
                        )

                    [files] => Array
                        (
                            [0] => name
                            [1] => url
                        )

                )

        )

    [result] => 1 or 0
)
GetInterview
Array
(
    [token] => String
    [id] => Int
    [format] => json
)
Array
(
    [data] => Array
        (
            [0] => ID
            [1] => user_id
            [2] => interview_date
            [3] => interview_gmdate
            [4] => interview_name
            [5] => interview_contact_phone
            [6] => interview_your_phone
            [7] => interview_meta
            [8] => interview_notes
            [9] => interview_archived
            [10] => casid
            [recording] => Array
                (
                    [0] => casid
                    [1] => duration
                    [2] => date
                    [3] => file
                )

            [files] => Array
                (
                    [0] => name
                    [1] => url
                )

        )

    [result] => 1 or 0
)
AddInterview
Array
(
    [token] => String
    [date] => Datetime string
    [contact_phone] => String
    [your_phone] => String
    [name] => String
    [notes] => String
    [format] => json
)
Array
(
    [data] => interview_id
    [result] => 1 or 0
)
UpdateInterview
Array
(
    [token] => String
    [id] => Number
    [date] => Datetime string
    [contact_phone] => String
    [your_phone] => String
    [name] => String
    [notes] => String
    [format] => json
)
Array
(
    [data] => 
    [result] => 1 or 0
)
CancelInterview
Array
(
    [token] => String
    [id] => Int
    [format] => json
)
Array
(
    [result] => 1 or 0
)
ArchiveInterview
Array
(
    [token] => String
    [id] => Int
    [format] => json
)
Array
(
    [result] => 1 or 0
)
UnarchiveInterview
Array
(
    [token] => String
    [id] => Int
    [format] => json
)
Array
(
    [result] => 1 or 0
)
BeginCall
Array
(
    [token] => String
    [id] => Int
)
Array
(
    [data] => 
    [result] => true or false
    [msg] => 
)
UploadFile
Array
(
    [token] => String
    [id] => String
    [new_file1] => File Input
    [format] => json
)
Array
(
    [result] => 1 or 0
)