MENU navbar-image
bash javascript php

Introduction

This documentation aims to provide all the information you need to work with our API.

Base URL

https://api.hipcall.com

Authenticating requests

This API is authenticated by sending an Authorization header with the value "Bearer {YOUR_AUTH_KEY}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can retrieve your token by visiting your dashboard and clicking Generate API token.

Call

List all Calls

requires authentication

This endpoint let you list calls. You can use embed, sort, search and filter feature at this endpoint.

Direction enum

Call resource has a direction field with integer type.

key description
1 Inbound
2 Outbound
3 Internal

Channel type enum

Hipcall plans to add web widget for call directly from your website until that channel_type always return 1 ( number ) and channel_id means number's id.

key description
1 Number
2 Web widget (coming soon)

Caller type enum

key description
1 Contact
2 User

Callee type enum

key description
1 Contact
2 User
3 Greeting (IVR)
4 Team (Queue)
null Hangup

Missing call reason enum

key description
1 out_of_business_hours
3 abandoned
2 short_abandoned
4 callback
Example request:
curl --request GET \
    --get "https://api.hipcall.com/api/v20211124/cdrs" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
const url = new URL(
    "https://api.hipcall.com/api/v20211124/cdrs"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.hipcall.com/api/v20211124/cdrs',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 30
x-ratelimit-remaining: 29
vary: Origin
 

{
    "data": [
        {
            "resource_type": "cdr",
            "uuid": "caedfd1b-25ec-447e-ad87-3b7eb3d358ea",
            "direction": 1,
            "user_id": 1,
            "contact_id": 2,
            "channel_type": 1,
            "channel_id": 1,
            "started_at": "2021-12-03T07:50:51+0000",
            "answered_at": null,
            "bridged_at": null,
            "ended_at": "2021-12-03T07:51:15+0000",
            "call_duration": 24,
            "first_touch_duration": 0,
            "missing_call": false,
            "missing_call_reason": 0,
            "caller_id": 1,
            "caller_type": 1,
            "caller_number": "+905326202911",
            "callee_id": 2,
            "callee_type": 3,
            "callee_number": "101"
        },
        {
            "resource_type": "cdr",
            "uuid": "0dfd67d3-918e-40ca-8ee6-785425a0e613",
            "direction": 1,
            "user_id": 1,
            "contact_id": 1,
            "channel_type": 1,
            "channel_id": 1,
            "started_at": "2021-12-03T07:50:51+0000",
            "answered_at": null,
            "bridged_at": null,
            "ended_at": "2021-12-03T07:57:16+0000",
            "call_duration": 385,
            "first_touch_duration": 0,
            "missing_call": false,
            "missing_call_reason": 0,
            "caller_id": 1,
            "caller_type": 1,
            "caller_number": "+905326202911",
            "callee_id": 2,
            "callee_type": 3,
            "callee_number": "101"
        },
        {
            "resource_type": "cdr",
            "uuid": "a79ee54d-099d-47cd-9aab-79bcd663c1cf",
            "direction": 1,
            "user_id": 1,
            "contact_id": 2,
            "channel_type": 1,
            "channel_id": 1,
            "started_at": "2021-12-03T07:50:51+0000",
            "answered_at": null,
            "bridged_at": null,
            "ended_at": "2021-12-03T07:59:01+0000",
            "call_duration": 490,
            "first_touch_duration": 0,
            "missing_call": false,
            "missing_call_reason": 0,
            "caller_id": 1,
            "caller_type": 1,
            "caller_number": "+905326202911",
            "callee_id": 2,
            "callee_type": 3,
            "callee_number": "101"
        },
        {
            "resource_type": "cdr",
            "uuid": "a976a6e5-8e96-4796-b236-5a8fcf850114",
            "direction": 1,
            "user_id": 2,
            "contact_id": 1,
            "channel_type": 1,
            "channel_id": 1,
            "started_at": "2021-12-03T07:50:51+0000",
            "answered_at": null,
            "bridged_at": null,
            "ended_at": "2021-12-03T07:55:55+0000",
            "call_duration": 304,
            "first_touch_duration": 0,
            "missing_call": false,
            "missing_call_reason": 0,
            "caller_id": 1,
            "caller_type": 1,
            "caller_number": "+905326202911",
            "callee_id": 2,
            "callee_type": 3,
            "callee_number": "101"
        },
        {
            "resource_type": "cdr",
            "uuid": "07e576b5-8bda-496c-be99-3078d3da826c",
            "direction": 1,
            "user_id": 1,
            "contact_id": 2,
            "channel_type": 1,
            "channel_id": 1,
            "started_at": "2021-12-03T07:50:51+0000",
            "answered_at": null,
            "bridged_at": null,
            "ended_at": "2021-12-03T07:51:16+0000",
            "call_duration": 25,
            "first_touch_duration": 0,
            "missing_call": false,
            "missing_call_reason": 0,
            "caller_id": 1,
            "caller_type": 1,
            "caller_number": "+905326202911",
            "callee_id": 2,
            "callee_type": 3,
            "callee_number": "101"
        },
        {
            "resource_type": "cdr",
            "uuid": "88aa64f1-18ed-402f-a90d-fedb556dda36",
            "direction": 1,
            "user_id": 1,
            "contact_id": 2,
            "channel_type": 1,
            "channel_id": 1,
            "started_at": "2021-12-03T07:50:51+0000",
            "answered_at": null,
            "bridged_at": null,
            "ended_at": "2021-12-03T07:56:49+0000",
            "call_duration": 358,
            "first_touch_duration": 0,
            "missing_call": false,
            "missing_call_reason": 0,
            "caller_id": 1,
            "caller_type": 1,
            "caller_number": "+905326202911",
            "callee_id": 2,
            "callee_type": 3,
            "callee_number": "101"
        },
        {
            "resource_type": "cdr",
            "uuid": "f3f21dac-f1d7-4624-90a1-dd8bb5d44170",
            "direction": 2,
            "user_id": 2,
            "contact_id": 2,
            "channel_type": 1,
            "channel_id": 1,
            "started_at": "2021-12-03T07:50:51+0000",
            "answered_at": null,
            "bridged_at": null,
            "ended_at": "2021-12-03T07:59:18+0000",
            "call_duration": 507,
            "first_touch_duration": 0,
            "missing_call": false,
            "missing_call_reason": 0,
            "caller_id": 2,
            "caller_type": 2,
            "caller_number": "+908508850000",
            "callee_id": 2,
            "callee_type": 1,
            "callee_number": "1015"
        },
        {
            "resource_type": "cdr",
            "uuid": "31a0cd1f-e4ad-4703-8b53-2254e44a76ba",
            "direction": 2,
            "user_id": 2,
            "contact_id": 1,
            "channel_type": 1,
            "channel_id": 1,
            "started_at": "2021-12-03T07:50:51+0000",
            "answered_at": null,
            "bridged_at": null,
            "ended_at": "2021-12-03T07:58:11+0000",
            "call_duration": 440,
            "first_touch_duration": 0,
            "missing_call": false,
            "missing_call_reason": 0,
            "caller_id": 2,
            "caller_type": 2,
            "caller_number": "+908508850000",
            "callee_id": 1,
            "callee_type": 1,
            "callee_number": "1015"
        },
        {
            "resource_type": "cdr",
            "uuid": "6dcfb220-3044-43f8-95e9-96612f5d4237",
            "direction": 2,
            "user_id": 1,
            "contact_id": 2,
            "channel_type": 1,
            "channel_id": 1,
            "started_at": "2021-12-03T07:50:51+0000",
            "answered_at": null,
            "bridged_at": null,
            "ended_at": "2021-12-03T07:50:53+0000",
            "call_duration": 2,
            "first_touch_duration": 0,
            "missing_call": false,
            "missing_call_reason": 0,
            "caller_id": 1,
            "caller_type": 2,
            "caller_number": "+908508850000",
            "callee_id": 2,
            "callee_type": 1,
            "callee_number": "1015"
        },
        {
            "resource_type": "cdr",
            "uuid": "7c02e761-5cdf-47d1-8b66-23ba1572133f",
            "direction": 2,
            "user_id": 2,
            "contact_id": 2,
            "channel_type": 1,
            "channel_id": 1,
            "started_at": "2021-12-03T07:50:51+0000",
            "answered_at": null,
            "bridged_at": null,
            "ended_at": "2021-12-03T07:59:06+0000",
            "call_duration": 495,
            "first_touch_duration": 0,
            "missing_call": false,
            "missing_call_reason": 0,
            "caller_id": 2,
            "caller_type": 2,
            "caller_number": "+908508850000",
            "callee_id": 2,
            "callee_type": 1,
            "callee_number": "1015"
        }
    ],
    "links": {
        "first": "http://localhost:8000/api/v20211124/cdrs?page=1",
        "last": null,
        "prev": null,
        "next": "http://localhost:8000/api/v20211124/cdrs?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "path": "http://localhost:8000/api/v20211124/cdrs",
        "per_page": "10",
        "to": 10
    }
}
 

Request      

GET api/v20211124/cdrs

URL Parameters

yyyy  integer  

The year of the call.

mm  integer  

The month of the call.

dd  integer  

The day of the call.

id  string  

The UUID of the call.

Body Parameters

q  string optional  

optional Search at caller_number, callee_number. Example ?q=497788123123.

embed  string optional  

optional Embed resource to response. Embeddable resources: user, channel, caller and callee. Example ?embed=user,channel,caller,callee.

sort  string optional  

optional Field to sort by. Defaults to 'started_at'. Sortable fields: started_at and call_duration. Example ?sort=started_at,-call_duration.

direction  string optional  

optional Filter by direction field. Supported params: 1, inbound, 2, outbound, 3, internal. Example ?direction=inbound,outbound.

users  string optional  

optional Filter by users field. Add users' ids. Example ?users=1 or ?users=1,4,5.

missing_call  string optional  

optional Filter by missing_call field. Supported param: true or false. Example ?missing_call=true.

missing_call_reason  string optional  

optional Filter by missing_call_reason field. Supported params: 1, out_of_business_hours, 2, short_abandoned, 3, abandoned, 4, callback. Example ?missing_call_reason=1,2 or ?missing_call_reason=callback.

Retrieve a Call

requires authentication

Use this endpoint to retrieve a Call data. You can use embed feature at this endpoint.

Example request:
curl --request GET \
    --get "https://api.hipcall.com/api/v20211124/cdrs/2021/11/25/caedfd1b-25ec-447e-ad87-3b7eb3d358ea" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
const url = new URL(
    "https://api.hipcall.com/api/v20211124/cdrs/2021/11/25/caedfd1b-25ec-447e-ad87-3b7eb3d358ea"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.hipcall.com/api/v20211124/cdrs/2021/11/25/caedfd1b-25ec-447e-ad87-3b7eb3d358ea',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 30
x-ratelimit-remaining: 28
vary: Origin
 

{
    "data": {
        "resource_type": "cdr",
        "uuid": "caedfd1b-25ec-447e-ad87-3b7eb3d358ea",
        "direction": 1,
        "user_id": 1,
        "contact_id": 2,
        "channel_type": 1,
        "channel_id": 1,
        "started_at": "2021-12-03T07:50:51+0000",
        "answered_at": null,
        "bridged_at": null,
        "ended_at": "2021-12-03T07:51:15+0000",
        "call_duration": 24,
        "first_touch_duration": 0,
        "missing_call": false,
        "missing_call_reason": 0,
        "caller_id": 1,
        "caller_type": 1,
        "caller_number": "+905326202911",
        "callee_id": 2,
        "callee_type": 3,
        "callee_number": "101"
    }
}
 

Request      

GET api/v20211124/cdrs/{yyyy}/{mm}/{dd}/{id}

URL Parameters

yyyy  integer  

Cdr year.

mm  integer  

Cdr month.

dd  integer  

Cdr day.

id  string optional  

uuid required Cdr uui id.

Body Parameters

embed  string optional  

Extension

List all Extensions

requires authentication

This endpoint let you list extensions. You can use sort, search and filter feature at this endpoint.

Example request:
curl --request GET \
    --get "https://api.hipcall.com/api/v20211124/extensions" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
const url = new URL(
    "https://api.hipcall.com/api/v20211124/extensions"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.hipcall.com/api/v20211124/extensions',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 30
x-ratelimit-remaining: 25
vary: Origin
 

{
    "data": [
        {
            "resource_type": "extension",
            "id": 1,
            "number": "1001",
            "target_id": 1,
            "created_at": "2021-12-03T07:50:51+0000",
            "updated_at": "2021-12-03T07:50:51+0000",
            "target_type": "user"
        },
        {
            "resource_type": "extension",
            "id": 2,
            "number": "1002",
            "target_id": 2,
            "created_at": "2021-12-03T07:50:51+0000",
            "updated_at": "2021-12-03T07:50:51+0000",
            "target_type": "user"
        },
        {
            "resource_type": "extension",
            "id": 4,
            "number": "101",
            "target_id": 1,
            "created_at": "2021-12-03T07:50:51+0000",
            "updated_at": "2021-12-03T07:50:51+0000",
            "target_type": "greeting"
        },
        {
            "resource_type": "extension",
            "id": 5,
            "number": "102",
            "target_id": 2,
            "created_at": "2021-12-03T07:50:51+0000",
            "updated_at": "2021-12-03T07:50:51+0000",
            "target_type": "greeting"
        },
        {
            "resource_type": "extension",
            "id": 3,
            "number": "300",
            "target_id": 1,
            "created_at": "2021-12-03T07:50:51+0000",
            "updated_at": "2021-12-03T07:50:51+0000",
            "target_type": "team"
        }
    ],
    "links": {
        "first": "http://localhost:8000/api/v20211124/extensions?page=1",
        "last": "http://localhost:8000/api/v20211124/extensions?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "http://localhost:8000/api/v20211124/extensions?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "http://localhost:8000/api/v20211124/extensions",
        "per_page": "10",
        "to": 5,
        "total": 5
    }
}
 

Request      

GET api/v20211124/extensions

Body Parameters

q  string optional  

optional Search at number. Example ?q=497788123123.

sort  string optional  

optional Field to sort by. Defaults to 'created_at'. Sortable fields: number, created_at and target_type. Example ?sort=target_type,number.

target  string optional  

optional Filter by target field. Supported params: user, team, greeting. Example ?target=inbound,team.

Retrieve an Extension

requires authentication

Use this endpoint to retrieve an Extension data.

Example request:
curl --request GET \
    --get "https://api.hipcall.com/api/v20211124/extensions/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.hipcall.com/api/v20211124/extensions/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.hipcall.com/api/v20211124/extensions/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 30
x-ratelimit-remaining: 24
vary: Origin
 

{
    "data": {
        "resource_type": "extension",
        "id": 1,
        "number": "1001",
        "target_id": 1,
        "created_at": "2021-12-03T07:50:51+0000",
        "updated_at": "2021-12-03T07:50:51+0000",
        "target_type": "user"
    }
}
 

Request      

GET api/v20211124/extensions/{id}

URL Parameters

id  integer  

The ID of the Extension.

Greeting

List all Greetings (IVRs)

requires authentication

This endpoint let you list greetings.

Example request:
curl --request GET \
    --get "https://api.hipcall.com/api/v20211124/greetings" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.hipcall.com/api/v20211124/greetings"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.hipcall.com/api/v20211124/greetings',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 30
x-ratelimit-remaining: 23
vary: Origin
 

{
    "data": [
        {
            "resource_type": "greeting",
            "id": 1,
            "name": "Out of business hours",
            "direct_dial_extension": false,
            "timeout": 0,
            "max_input_try_count": 0,
            "state": "active"
        },
        {
            "resource_type": "greeting",
            "id": 2,
            "name": "Welcome to Microsoft",
            "direct_dial_extension": true,
            "timeout": 0,
            "max_input_try_count": 3,
            "state": "active"
        }
    ],
    "links": {
        "first": "http://localhost:8000/api/v20211124/greetings?page=1",
        "last": "http://localhost:8000/api/v20211124/greetings?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "http://localhost:8000/api/v20211124/greetings?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "http://localhost:8000/api/v20211124/greetings",
        "per_page": "10",
        "to": 2,
        "total": 2
    }
}
 

Request      

GET api/v20211124/greetings

Retrieve a Greeting (IVR)

requires authentication

Use this endpoint to retrieve a Greeting (IVR) data.

Example request:
curl --request GET \
    --get "https://api.hipcall.com/api/v20211124/greetings/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.hipcall.com/api/v20211124/greetings/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.hipcall.com/api/v20211124/greetings/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 30
x-ratelimit-remaining: 22
vary: Origin
 

{
    "data": {
        "resource_type": "greeting",
        "id": 1,
        "name": "Out of business hours",
        "direct_dial_extension": false,
        "timeout": 0,
        "max_input_try_count": 0,
        "state": "active"
    }
}
 

Request      

GET api/v20211124/greetings/{id}

URL Parameters

id  integer  

The ID of the Greeting (IVR).

Number

List all Numbers

requires authentication

This endpoint let you list numbers.

Example request:
curl --request GET \
    --get "https://api.hipcall.com/api/v20211124/numbers" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.hipcall.com/api/v20211124/numbers"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.hipcall.com/api/v20211124/numbers',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 30
x-ratelimit-remaining: 21
vary: Origin
 

{
    "data": [
        {
            "resource_type": "number",
            "id": 1,
            "name": "Turkey Support Number",
            "number": "+908503902777"
        }
    ],
    "links": {
        "first": "http://localhost:8000/api/v20211124/numbers?page=1",
        "last": "http://localhost:8000/api/v20211124/numbers?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "http://localhost:8000/api/v20211124/numbers?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "http://localhost:8000/api/v20211124/numbers",
        "per_page": "10",
        "to": 1,
        "total": 1
    }
}
 

Request      

GET api/v20211124/numbers

Retrieve a Number

requires authentication

Use this endpoint to retrieve a Number data.

Example request:
curl --request GET \
    --get "https://api.hipcall.com/api/v20211124/numbers/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.hipcall.com/api/v20211124/numbers/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.hipcall.com/api/v20211124/numbers/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 30
x-ratelimit-remaining: 20
vary: Origin
 

{
    "data": {
        "resource_type": "number",
        "id": 1,
        "name": "Turkey Support Number",
        "number": "+908503902777"
    }
}
 

Request      

GET api/v20211124/numbers/{id}

URL Parameters

id  integer  

The ID of the Number.

Task

List all Tasks

requires authentication

This endpoint let you list tasks. You can use sort and filter feature at this endpoint.

Example request:
curl --request GET \
    --get "https://api.hipcall.com/api/v20211124/tasks" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
const url = new URL(
    "https://api.hipcall.com/api/v20211124/tasks"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.hipcall.com/api/v20211124/tasks',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 30
x-ratelimit-remaining: 17
vary: Origin
 

{
    "data": [
        {
            "resource_type": "task",
            "id": 1,
            "name": "Quia qui nemo aliquid beatae commodi est.",
            "description": "Necessitatibus provident non ipsa. Aut quibusdam qui voluptatem quo consequatur rerum nemo. Et perferendis illum qui dicta.",
            "due_date": null,
            "done": true,
            "done_at": "1976-03-27T19:32:52+0000",
            "assign_to": null,
            "priority": "low",
            "task_list_id": null,
            "created_at": "2021-12-03T07:50:51+0000",
            "updated_at": "2021-12-03T07:50:51+0000"
        },
        {
            "resource_type": "task",
            "id": 2,
            "name": "Voluptas eveniet eum voluptatibus quia.",
            "description": "Animi qui dolore harum rem sed qui sed. Quia nulla harum soluta sed et delectus ad architecto. Mollitia accusantium quia iusto aperiam.",
            "due_date": "2021-12-05T10:04:31+0000",
            "done": true,
            "done_at": "2018-03-31T01:30:43+0000",
            "assign_to": null,
            "priority": "low",
            "task_list_id": null,
            "created_at": "2021-12-03T07:50:51+0000",
            "updated_at": "2021-12-03T07:50:51+0000"
        },
        {
            "resource_type": "task",
            "id": 3,
            "name": "Dolores sed ea porro sint quos.",
            "description": "Occaecati eius veritatis eveniet numquam. Eos sint id tempore ipsa dignissimos. Est fugit odio eveniet quasi.",
            "due_date": "2021-12-02T15:40:27+0000",
            "done": true,
            "done_at": "1985-06-24T22:24:12+0000",
            "assign_to": null,
            "priority": "high",
            "task_list_id": null,
            "created_at": "2021-12-03T07:50:51+0000",
            "updated_at": "2021-12-03T07:50:51+0000"
        },
        {
            "resource_type": "task",
            "id": 4,
            "name": "Nulla qui aperiam quam ullam iste fugit nemo.",
            "description": "Voluptate sit ullam sint vel inventore error omnis. Ullam consectetur ut recusandae animi. Quia quia animi laboriosam dignissimos velit nisi.",
            "due_date": "2021-11-27T09:55:51+0000",
            "done": true,
            "done_at": "2000-08-09T11:59:12+0000",
            "assign_to": null,
            "priority": "high",
            "task_list_id": null,
            "created_at": "2021-12-03T07:50:51+0000",
            "updated_at": "2021-12-03T07:50:51+0000"
        },
        {
            "resource_type": "task",
            "id": 5,
            "name": "Corporis et voluptatem velit ut vel.",
            "description": "Corrupti rerum minus aut. In illum et quam in. Tenetur ut et omnis asperiores blanditiis et.",
            "due_date": "2021-12-10T14:41:14+0000",
            "done": true,
            "done_at": "1980-05-14T16:36:04+0000",
            "assign_to": null,
            "priority": "low",
            "task_list_id": null,
            "created_at": "2021-12-03T07:50:51+0000",
            "updated_at": "2021-12-03T07:50:51+0000"
        },
        {
            "resource_type": "task",
            "id": 6,
            "name": "Aut commodi esse veritatis ullam dolores.",
            "description": "Magni et explicabo cumque aliquid dicta voluptatem ullam quibusdam. Aperiam animi autem voluptas quia vel labore.",
            "due_date": "2021-12-22T12:58:02+0000",
            "done": false,
            "done_at": null,
            "assign_to": null,
            "priority": "",
            "task_list_id": null,
            "created_at": "2021-12-03T07:50:51+0000",
            "updated_at": "2021-12-03T07:50:51+0000"
        },
        {
            "resource_type": "task",
            "id": 7,
            "name": "Non culpa a et animi dolorem.",
            "description": "Et quo est laborum laboriosam. Ratione minima rerum quisquam repellendus voluptatem laborum aut. Ea omnis illo rerum omnis.",
            "due_date": "2021-12-28T09:19:47+0000",
            "done": true,
            "done_at": "2002-05-15T17:45:46+0000",
            "assign_to": null,
            "priority": "medium",
            "task_list_id": null,
            "created_at": "2021-12-03T07:50:51+0000",
            "updated_at": "2021-12-03T07:50:51+0000"
        },
        {
            "resource_type": "task",
            "id": 8,
            "name": "Consectetur distinctio harum nihil iste.",
            "description": "Distinctio sapiente commodi ab aliquid. Voluptate aspernatur sit ex. Repellendus similique magnam voluptatum rerum fugiat id.",
            "due_date": null,
            "done": false,
            "done_at": null,
            "assign_to": null,
            "priority": "",
            "task_list_id": null,
            "created_at": "2021-12-03T07:50:51+0000",
            "updated_at": "2021-12-03T07:50:51+0000"
        },
        {
            "resource_type": "task",
            "id": 9,
            "name": "Autem totam et sed et eum enim qui officia.",
            "description": "Repudiandae consequatur vel nihil facilis cupiditate nesciunt magnam. Iure rem quidem praesentium.",
            "due_date": "2021-11-28T22:03:36+0000",
            "done": false,
            "done_at": null,
            "assign_to": null,
            "priority": "low",
            "task_list_id": null,
            "created_at": "2021-12-03T07:50:51+0000",
            "updated_at": "2021-12-03T07:50:51+0000"
        },
        {
            "resource_type": "task",
            "id": 10,
            "name": "Eaque tempora ipsam tempora similique.",
            "description": "Molestiae reiciendis nam qui voluptas. Eligendi rerum dolor ducimus magni ut minus. Omnis est inventore fugit eveniet hic.",
            "due_date": null,
            "done": false,
            "done_at": null,
            "assign_to": null,
            "priority": "medium",
            "task_list_id": null,
            "created_at": "2021-12-03T07:50:51+0000",
            "updated_at": "2021-12-03T07:50:51+0000"
        }
    ],
    "links": {
        "first": "http://localhost:8000/api/v20211124/tasks?page=1",
        "last": "http://localhost:8000/api/v20211124/tasks?page=2",
        "prev": null,
        "next": "http://localhost:8000/api/v20211124/tasks?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 2,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "http://localhost:8000/api/v20211124/tasks?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": "http://localhost:8000/api/v20211124/tasks?page=2",
                "label": "2",
                "active": false
            },
            {
                "url": "http://localhost:8000/api/v20211124/tasks?page=2",
                "label": "Next »",
                "active": false
            }
        ],
        "path": "http://localhost:8000/api/v20211124/tasks",
        "per_page": "10",
        "to": 10,
        "total": 11
    }
}
 

Request      

GET api/v20211124/tasks

Body Parameters

q  string optional  

priority  string optional  

optional Filter by priority field. Supported params: low, medium, high. Example ?priority=high,medium.

assign_to  string optional  

optional Filter by assign_to field. Add users' ids. Example ?assign_to=1 or ?assign_to=1,4,5.

sort  string optional  

optional Field to sort by. Defaults to 'due_date'. Sortable fields: due_date. Example ?sort=due_date.

Retrieve a Task

requires authentication

Use this endpoint to retrieve a Task data.

Example request:
curl --request GET \
    --get "https://api.hipcall.com/api/v20211124/tasks/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.hipcall.com/api/v20211124/tasks/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.hipcall.com/api/v20211124/tasks/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 30
x-ratelimit-remaining: 16
vary: Origin
 

{
    "data": {
        "resource_type": "task",
        "id": 1,
        "name": "Quia qui nemo aliquid beatae commodi est.",
        "description": "Necessitatibus provident non ipsa. Aut quibusdam qui voluptatem quo consequatur rerum nemo. Et perferendis illum qui dicta.",
        "due_date": null,
        "done": true,
        "done_at": "1976-03-27 19:32:52",
        "assign_to": null,
        "priority": "low",
        "task_list_id": null,
        "created_at": "2021-12-03T07:50:51+0000",
        "updated_at": "2021-12-03T07:50:51+0000"
    }
}
 

Request      

GET api/v20211124/tasks/{id}

URL Parameters

id  integer  

The ID of the Task.

Team

List all Teams

requires authentication

This endpoint let you list teams. You can use search and filter feature at this endpoint.

Example request:
curl --request GET \
    --get "https://api.hipcall.com/api/v20211124/teams" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
const url = new URL(
    "https://api.hipcall.com/api/v20211124/teams"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.hipcall.com/api/v20211124/teams',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 30
x-ratelimit-remaining: 19
vary: Origin
 

{
    "data": [
        {
            "resource_type": "team",
            "id": 1,
            "name": "Microsoft Team",
            "user_case": "all",
            "wrap_up_time": 15,
            "strategy": "random",
            "say_line_number": true,
            "say_line_number_in_second": 120,
            "callback": false,
            "callback_dtmf": 0,
            "callback_action": "none",
            "state": "active"
        }
    ],
    "links": {
        "first": "http://localhost:8000/api/v20211124/teams?page=1",
        "last": "http://localhost:8000/api/v20211124/teams?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "http://localhost:8000/api/v20211124/teams?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "http://localhost:8000/api/v20211124/teams",
        "per_page": "10",
        "to": 1,
        "total": 1
    }
}
 

Request      

GET api/v20211124/teams

Body Parameters

q  string optional  

optional Search at name. Example ?q=Sales.

status  string optional  

optional Filter by status field. Supported params: 1, active, 0, passive. Example ?status=active.

Retrieve a Team

requires authentication

Use this endpoint to retrieve a Team data.

Example request:
curl --request GET \
    --get "https://api.hipcall.com/api/v20211124/teams/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.hipcall.com/api/v20211124/teams/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.hipcall.com/api/v20211124/teams/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 30
x-ratelimit-remaining: 18
vary: Origin
 

{
    "data": {
        "resource_type": "team",
        "id": 1,
        "name": "Microsoft Team",
        "user_case": "all",
        "wrap_up_time": 15,
        "strategy": "random",
        "say_line_number": true,
        "say_line_number_in_second": 120,
        "callback": false,
        "callback_dtmf": 0,
        "callback_action": "none",
        "state": "active"
    }
}
 

Request      

GET api/v20211124/teams/{id}

URL Parameters

id  integer  

The ID of the Team.

User

List all Users

requires authentication

This endpoint let you list users. You can use search and filter feature at this endpoint.

Example request:
curl --request GET \
    --get "https://api.hipcall.com/api/v20211124/users" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
const url = new URL(
    "https://api.hipcall.com/api/v20211124/users"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.hipcall.com/api/v20211124/users',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 30
x-ratelimit-remaining: 27
vary: Origin
 

{
    "data": [
        {
            "resource_type": "user",
            "id": 1,
            "email": "bill@microsoft.com",
            "name": "Bill Gates",
            "title": "Co-founder",
            "owner": true,
            "locale": "en",
            "status": "active",
            "default_number_id": 1,
            "2fa": false,
            "last_logged_in": null,
            "created_at": "2021-12-03T07:50:50+0000",
            "updated_at": "2021-12-03T07:50:51+0000"
        },
        {
            "resource_type": "user",
            "id": 2,
            "email": "satya@microsoft.com",
            "name": "Satya Nadella",
            "title": "CEO",
            "owner": false,
            "locale": "en",
            "status": "active",
            "default_number_id": 1,
            "2fa": false,
            "last_logged_in": null,
            "created_at": "2021-12-03T07:50:51+0000",
            "updated_at": "2021-12-03T07:50:51+0000"
        }
    ],
    "links": {
        "first": "http://localhost:8000/api/v20211124/users?page=1",
        "last": "http://localhost:8000/api/v20211124/users?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "http://localhost:8000/api/v20211124/users?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "http://localhost:8000/api/v20211124/users",
        "per_page": "10",
        "to": 2,
        "total": 2
    }
}
 

Request      

GET api/v20211124/users

Body Parameters

q  string optional  

optional Search at first_name, last_name and email. Example ?q=Bill.

status  string optional  

optional Filter by status field. Supported params: 1, active, 0, passive. Example ?status=active.

Retrieve a User

requires authentication

Use this endpoint to retrieve a User data.

Example request:
curl --request GET \
    --get "https://api.hipcall.com/api/v20211124/users/2" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.hipcall.com/api/v20211124/users/2"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.hipcall.com/api/v20211124/users/2',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 30
x-ratelimit-remaining: 26
vary: Origin
 

{
    "data": {
        "resource_type": "user",
        "id": 2,
        "email": "satya@microsoft.com",
        "name": "Satya Nadella",
        "title": "CEO",
        "owner": false,
        "locale": "en",
        "default_number_id": 1,
        "2fa": false,
        "last_logged_in": null,
        "created_at": "2021-12-03T07:50:51+0000",
        "updated_at": "2021-12-03T07:50:51+0000"
    }
}
 

Request      

GET api/v20211124/users/{id}

URL Parameters

id  integer  

The ID of the User.