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 |
Hangup by enum
Call resource has a hangup_by
field with integer type.
key | description |
---|---|
1 | User |
2 | Contact |
3 | System |
Voicemail type enum
Call resource has a voicemail_type
field with integer type. There are two type voicemail feature
in the Hipcall. User's voicemail and system voicemail.
key | description |
---|---|
1 | User |
2 | Account |
If the voicemail_type
is account
, voicemail_id
is voicemail.id. If the voicemail_type
is
user, voicemail_id
is user.id.
Important note on record_url
This URL will be expired in 60 minutes. It isn't a good idea to store this URL in your database.
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": 2,
"contact_id": 0,
"channel_type": 1,
"channel_id": 1,
"started_at": "2023-03-31T08:41:58+0000",
"answered_at": null,
"bridged_at": null,
"ended_at": "2023-03-31T08:45:01+0000",
"call_duration": 183,
"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",
"record_url": null,
"hangup_by": 1,
"voicemail_type": null,
"voicemail_id": null,
"voicemail_url": null
},
{
"resource_type": "cdr",
"uuid": "7b7a0388-a743-4060-82f8-0bc92e48482e",
"direction": 1,
"user_id": 1,
"contact_id": 0,
"channel_type": 1,
"channel_id": 1,
"started_at": "2023-03-31T08:41:58+0000",
"answered_at": null,
"bridged_at": null,
"ended_at": "2023-03-31T08:43:53+0000",
"call_duration": 115,
"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",
"record_url": null,
"hangup_by": 2,
"voicemail_type": null,
"voicemail_id": null,
"voicemail_url": null
},
{
"resource_type": "cdr",
"uuid": "5a836c78-9747-40bb-b370-98033e8d295c",
"direction": 1,
"user_id": 2,
"contact_id": 0,
"channel_type": 1,
"channel_id": 1,
"started_at": "2023-03-31T08:41:58+0000",
"answered_at": null,
"bridged_at": null,
"ended_at": "2023-03-31T08:45:29+0000",
"call_duration": 211,
"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",
"record_url": null,
"hangup_by": 1,
"voicemail_type": null,
"voicemail_id": null,
"voicemail_url": null
},
{
"resource_type": "cdr",
"uuid": "9e42f131-6ccd-49f0-9e64-c9e0fe882034",
"direction": 1,
"user_id": 1,
"contact_id": 0,
"channel_type": 1,
"channel_id": 1,
"started_at": "2023-03-31T08:41:58+0000",
"answered_at": null,
"bridged_at": null,
"ended_at": "2023-03-31T08:44:29+0000",
"call_duration": 151,
"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",
"record_url": null,
"hangup_by": 3,
"voicemail_type": null,
"voicemail_id": null,
"voicemail_url": null
},
{
"resource_type": "cdr",
"uuid": "68c9ac98-c040-4cff-83b4-081f57eec91e",
"direction": 1,
"user_id": 1,
"contact_id": 0,
"channel_type": 1,
"channel_id": 1,
"started_at": "2023-03-31T08:41:58+0000",
"answered_at": null,
"bridged_at": null,
"ended_at": "2023-03-31T08:42:53+0000",
"call_duration": 55,
"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",
"record_url": null,
"hangup_by": 3,
"voicemail_type": null,
"voicemail_id": null,
"voicemail_url": null
},
{
"resource_type": "cdr",
"uuid": "dd511480-63f7-41ed-bc7c-6a6566d12476",
"direction": 1,
"user_id": 1,
"contact_id": 0,
"channel_type": 1,
"channel_id": 1,
"started_at": "2023-03-31T08:41:58+0000",
"answered_at": null,
"bridged_at": null,
"ended_at": "2023-03-31T08:51:04+0000",
"call_duration": 546,
"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",
"record_url": null,
"hangup_by": 3,
"voicemail_type": null,
"voicemail_id": null,
"voicemail_url": null
},
{
"resource_type": "cdr",
"uuid": "7f1c54c8-5a87-4ace-8ace-a5c3bbe2c43b",
"direction": 1,
"user_id": 2,
"contact_id": 0,
"channel_type": 1,
"channel_id": 1,
"started_at": "2023-03-31T08:41:58+0000",
"answered_at": null,
"bridged_at": null,
"ended_at": "2023-03-31T08:51:11+0000",
"call_duration": 553,
"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",
"record_url": null,
"hangup_by": 3,
"voicemail_type": null,
"voicemail_id": null,
"voicemail_url": null
},
{
"resource_type": "cdr",
"uuid": "fe01a663-171b-40d2-a323-000b30af9ef9",
"direction": 1,
"user_id": 1,
"contact_id": 0,
"channel_type": 1,
"channel_id": 1,
"started_at": "2023-03-31T08:41:58+0000",
"answered_at": null,
"bridged_at": null,
"ended_at": "2023-03-31T08:43:36+0000",
"call_duration": 98,
"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",
"record_url": null,
"hangup_by": 2,
"voicemail_type": null,
"voicemail_id": null,
"voicemail_url": null
},
{
"resource_type": "cdr",
"uuid": "41eb8054-5f62-4815-aa07-e9a24fe0f7ea",
"direction": 2,
"user_id": 1,
"contact_id": 0,
"channel_type": 1,
"channel_id": 1,
"started_at": "2023-03-31T08:41:58+0000",
"answered_at": null,
"bridged_at": null,
"ended_at": "2023-03-31T08:51:01+0000",
"call_duration": 543,
"first_touch_duration": 0,
"missing_call": false,
"missing_call_reason": 0,
"caller_id": 1,
"caller_type": 2,
"caller_number": "+908508850000",
"callee_id": 1,
"callee_type": 1,
"callee_number": "1015",
"record_url": null,
"hangup_by": 2,
"voicemail_type": null,
"voicemail_id": null,
"voicemail_url": null
},
{
"resource_type": "cdr",
"uuid": "bf917126-776d-4cb3-a6ad-5673d27e6fb1",
"direction": 3,
"user_id": 1,
"contact_id": 0,
"channel_type": 1,
"channel_id": 1,
"started_at": "2023-03-31T08:41:58+0000",
"answered_at": null,
"bridged_at": null,
"ended_at": "2023-03-31T08:49:33+0000",
"call_duration": 455,
"first_touch_duration": 0,
"missing_call": false,
"missing_call_reason": 0,
"caller_id": 1,
"caller_type": 2,
"caller_number": "1001",
"callee_id": 2,
"callee_type": 2,
"callee_number": "1002",
"record_url": null,
"hangup_by": 3,
"voicemail_type": null,
"voicemail_id": null,
"voicemail_url": null
}
],
"links": {
"first": "https://api.hipcall.com/api/v20211124/cdrs?page=1",
"last": null,
"prev": null,
"next": "https://api.hipcall.com/api/v20211124/cdrs?page=2"
},
"meta": {
"current_page": 1,
"from": 1,
"path": "https://api.hipcall.com/api/v20211124/cdrs",
"per_page": "10",
"to": 10
}
}
Received response:
Request failed with error:
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": 2,
"contact_id": 0,
"channel_type": 1,
"channel_id": 1,
"started_at": "2023-03-31T08:41:58+0000",
"answered_at": null,
"bridged_at": null,
"ended_at": "2023-03-31T08:45:01+0000",
"call_duration": 183,
"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",
"record_url": null,
"hangup_by": 1,
"voicemail_type": null,
"voicemail_id": null,
"voicemail_url": null,
"call_flow": [
{
"action": "hangup",
"detail": {
"hangup_by": "contact"
},
"timestamp": "2021-11-23T13:00:00+0000"
},
{
"action": "bridge",
"detail": {
"id": 1,
"type": "user"
},
"timestamp": "2021-11-23T12:59:56+0000"
},
{
"action": "bridge_attempt",
"detail": {
"id": 1,
"type": "user"
},
"timestamp": "2021-11-23T12:59:50+0000"
},
{
"action": "bridge_fail",
"detail": {
"id": 2,
"result": 21,
"type": "user"
},
"timestamp": "2021-11-23T12:59:46+0000"
},
{
"action": "bridge_attempt",
"detail": {
"id": 2,
"type": "user"
},
"timestamp": "2021-11-23T12:59:45+0000"
},
{
"action": "route",
"detail": {
"id": 1,
"type": "team"
},
"timestamp": "2021-11-23T12:59:33+0000"
},
{
"action": "route",
"detail": {
"id": 1,
"type": "greeting"
},
"timestamp": "2021-11-23T12:59:20+0000"
},
{
"action": "init",
"detail": {
"id": 1,
"type": "user"
},
"timestamp": "2021-11-23T12:59:15+0000"
}
]
}
}
Received response:
Request failed with error:
Comment
Create a comment
requires authentication
Use this endpoint to create a Comment data.
Example request:
curl --request POST \
"https://api.hipcall.com/api/v20211124/comments" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"commentable_type\": \"company\",
\"content\": \"20220612 12:12:12\",
\"commentable_id\": 1
}"
const url = new URL(
"https://api.hipcall.com/api/v20211124/comments"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"commentable_type": "company",
"content": "20220612 12:12:12",
"commentable_id": 1
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
'https://api.hipcall.com/api/v20211124/comments',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'commentable_type' => 'company',
'content' => '20220612 12:12:12',
'commentable_id' => 1,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
Received response:
Request failed with error:
Company
Add tags to company.
requires authentication
Use this endpoint to add tags to company.
Remove a tag from company.
requires authentication
Use this endpoint to remove a tag from company.
Contact
Add tags to contact.
requires authentication
Use this endpoint to add tags to contact.
Remove a tag from contact.
requires authentication
Use this endpoint to remove a tag from contact.
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": 4,
"number": "1001",
"target_id": 1,
"target_type": "user",
"created_at": "2023-03-31T08:41:58+0000",
"updated_at": "2023-03-31T08:41:58+0000"
},
{
"resource_type": "extension",
"id": 5,
"number": "1002",
"target_id": 2,
"target_type": "user",
"created_at": "2023-03-31T08:41:58+0000",
"updated_at": "2023-03-31T08:41:58+0000"
},
{
"resource_type": "extension",
"id": 7,
"number": "101",
"target_id": 3,
"target_type": "greeting",
"created_at": "2023-03-31T08:41:58+0000",
"updated_at": "2023-03-31T08:41:58+0000"
},
{
"resource_type": "extension",
"id": 8,
"number": "102",
"target_id": 4,
"target_type": "greeting",
"created_at": "2023-03-31T08:41:58+0000",
"updated_at": "2023-03-31T08:41:58+0000"
},
{
"resource_type": "extension",
"id": 6,
"number": "300",
"target_id": 2,
"target_type": "team",
"created_at": "2023-03-31T08:41:58+0000",
"updated_at": "2023-03-31T08:41:58+0000"
},
{
"resource_type": "extension",
"id": 1,
"number": "800",
"target_id": 1,
"target_type": "greeting",
"created_at": "2023-03-31T08:41:58+0000",
"updated_at": "2023-03-31T08:41:58+0000"
},
{
"resource_type": "extension",
"id": 3,
"number": "801",
"target_id": 1,
"target_type": "team",
"created_at": "2023-03-31T08:41:58+0000",
"updated_at": "2023-03-31T08:41:58+0000"
},
{
"resource_type": "extension",
"id": 2,
"number": "802",
"target_id": 2,
"target_type": "greeting",
"created_at": "2023-03-31T08:41:58+0000",
"updated_at": "2023-03-31T08:41:58+0000"
}
],
"links": {
"first": "https://api.hipcall.com/api/v20211124/extensions?page=1",
"last": "https://api.hipcall.com/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": "https://api.hipcall.com/api/v20211124/extensions?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"path": "https://api.hipcall.com/api/v20211124/extensions",
"per_page": 10,
"to": 8,
"total": 8
}
}
Received response:
Request failed with error:
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": "800",
"target_id": 1,
"target_type": "greeting",
"created_at": "2023-03-31T08:41:58+0000",
"updated_at": "2023-03-31T08:41:58+0000"
}
}
Received response:
Request failed with error:
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": "Welcome",
"direct_dial_extension": true,
"timeout": 0,
"max_input_try_count": 1,
"state": "active"
},
{
"resource_type": "greeting",
"id": 2,
"name": "Out of business hours",
"direct_dial_extension": false,
"timeout": 0,
"max_input_try_count": 0,
"state": "active"
},
{
"resource_type": "greeting",
"id": 3,
"name": "Out of business hours",
"direct_dial_extension": false,
"timeout": 0,
"max_input_try_count": 0,
"state": "active"
},
{
"resource_type": "greeting",
"id": 4,
"name": "Welcome to Microsoft",
"direct_dial_extension": true,
"timeout": 0,
"max_input_try_count": 1,
"state": "active"
}
],
"links": {
"first": "https://api.hipcall.com/api/v20211124/greetings?page=1",
"last": "https://api.hipcall.com/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": "https://api.hipcall.com/api/v20211124/greetings?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"path": "https://api.hipcall.com/api/v20211124/greetings",
"per_page": 10,
"to": 4,
"total": 4
}
}
Received response:
Request failed with error:
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": "Welcome",
"direct_dial_extension": true,
"timeout": 0,
"max_input_try_count": 1,
"state": "active"
}
}
Received response:
Request failed with error:
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": "https://api.hipcall.com/api/v20211124/numbers?page=1",
"last": "https://api.hipcall.com/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": "https://api.hipcall.com/api/v20211124/numbers?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"path": "https://api.hipcall.com/api/v20211124/numbers",
"per_page": 10,
"to": 1,
"total": 1
}
}
Received response:
Request failed with error:
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"
}
}
Received response:
Request failed with error:
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": "Porro iure blanditiis et debitis.",
"description": "Repellendus ab laborum non voluptatem maxime. Culpa dolorem nihil laboriosam nemo itaque aut. Cupiditate ut quis qui omnis consequatur nesciunt ut.",
"due_date": null,
"done": false,
"done_at": null,
"assign_to": null,
"priority": "low",
"task_list_id": null,
"created_at": "2023-03-31T08:41:58+0000",
"updated_at": "2023-03-31T08:41:58+0000"
},
{
"resource_type": "task",
"id": 2,
"name": "Ut et sed assumenda totam odit.",
"description": "Quo libero doloremque explicabo quo dolorem ratione voluptas. Et harum fugit eum dolores dignissimos non reiciendis.",
"due_date": null,
"done": true,
"done_at": "2006-09-21T00:00:54+0000",
"assign_to": null,
"priority": "medium",
"task_list_id": null,
"created_at": "2023-03-31T08:41:58+0000",
"updated_at": "2023-03-31T08:41:58+0000"
},
{
"resource_type": "task",
"id": 3,
"name": "Sit reprehenderit officia non et.",
"description": "Labore voluptatem sed temporibus ut aut. Impedit quisquam ipsa vero atque nulla ea aut. Saepe eum enim rerum atque est vero. Non quasi et autem.",
"due_date": null,
"done": false,
"done_at": null,
"assign_to": null,
"priority": "low",
"task_list_id": null,
"created_at": "2023-03-31T08:41:58+0000",
"updated_at": "2023-03-31T08:41:58+0000"
},
{
"resource_type": "task",
"id": 4,
"name": "Velit voluptatum ut corrupti voluptas.",
"description": "Velit odio ipsa eius animi corrupti illo velit debitis. Eum sint et culpa. Ipsum eveniet ad voluptas ad quae voluptatem eos.",
"due_date": null,
"done": false,
"done_at": null,
"assign_to": null,
"priority": "",
"task_list_id": null,
"created_at": "2023-03-31T08:41:58+0000",
"updated_at": "2023-03-31T08:41:58+0000"
},
{
"resource_type": "task",
"id": 5,
"name": "Magni quia quod sint culpa voluptate quis sed.",
"description": "Reprehenderit perferendis sit voluptatem et et autem. Ducimus et corrupti consequuntur sit praesentium aut. Voluptas sunt ullam quisquam ab non odio.",
"due_date": "2023-04-09T15:49:23+0000",
"done": true,
"done_at": "2003-03-07T19:25:49+0000",
"assign_to": null,
"priority": "",
"task_list_id": null,
"created_at": "2023-03-31T08:41:58+0000",
"updated_at": "2023-03-31T08:41:58+0000"
},
{
"resource_type": "task",
"id": 6,
"name": "Illo veritatis sed dolorem.",
"description": "Nulla soluta est soluta aut sint illum. Minus minima officiis quisquam. Ex facilis voluptates nihil consequatur minima.",
"due_date": "2023-04-17T13:12:39+0000",
"done": true,
"done_at": "2013-03-06T05:37:56+0000",
"assign_to": null,
"priority": "low",
"task_list_id": null,
"created_at": "2023-03-31T08:41:58+0000",
"updated_at": "2023-03-31T08:41:58+0000"
},
{
"resource_type": "task",
"id": 7,
"name": "Quisquam quia quibusdam facilis dolor.",
"description": "Excepturi eum quo et odio at aut. Minima quibusdam itaque veniam.",
"due_date": null,
"done": false,
"done_at": null,
"assign_to": null,
"priority": "low",
"task_list_id": null,
"created_at": "2023-03-31T08:41:58+0000",
"updated_at": "2023-03-31T08:41:58+0000"
},
{
"resource_type": "task",
"id": 8,
"name": "Molestiae enim eum minus dolorem tempore.",
"description": "Molestiae facilis aperiam qui non ut adipisci amet est. Eaque et cum ratione architecto. Expedita sit minima voluptatibus enim tenetur qui placeat.",
"due_date": "2023-03-26T20:44:56+0000",
"done": false,
"done_at": null,
"assign_to": null,
"priority": "low",
"task_list_id": null,
"created_at": "2023-03-31T08:41:58+0000",
"updated_at": "2023-03-31T08:41:58+0000"
},
{
"resource_type": "task",
"id": 9,
"name": "Nesciunt animi accusamus nulla.",
"description": "Ut fuga molestiae laborum in. Perferendis ut autem id fugiat nemo in expedita. Libero possimus aperiam provident.",
"due_date": "2023-03-21T01:44:15+0000",
"done": false,
"done_at": null,
"assign_to": null,
"priority": "medium",
"task_list_id": null,
"created_at": "2023-03-31T08:41:58+0000",
"updated_at": "2023-03-31T08:41:58+0000"
},
{
"resource_type": "task",
"id": 10,
"name": "Aperiam provident fugiat officia unde eius eos.",
"description": "Accusamus quae repellendus omnis dolor ratione ut. Voluptatem expedita ut repudiandae delectus alias quo sed. Iusto earum corporis pariatur.",
"due_date": null,
"done": false,
"done_at": null,
"assign_to": null,
"priority": "",
"task_list_id": null,
"created_at": "2023-03-31T08:41:58+0000",
"updated_at": "2023-03-31T08:41:58+0000"
}
],
"links": {
"first": "https://api.hipcall.com/api/v20211124/tasks?page=1",
"last": "https://api.hipcall.com/api/v20211124/tasks?page=2",
"prev": null,
"next": "https://api.hipcall.com/api/v20211124/tasks?page=2"
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 2,
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "https://api.hipcall.com/api/v20211124/tasks?page=1",
"label": "1",
"active": true
},
{
"url": "https://api.hipcall.com/api/v20211124/tasks?page=2",
"label": "2",
"active": false
},
{
"url": "https://api.hipcall.com/api/v20211124/tasks?page=2",
"label": "Next »",
"active": false
}
],
"path": "https://api.hipcall.com/api/v20211124/tasks",
"per_page": 10,
"to": 10,
"total": 11
}
}
Received response:
Request failed with error:
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": "Porro iure blanditiis et debitis.",
"description": "Repellendus ab laborum non voluptatem maxime. Culpa dolorem nihil laboriosam nemo itaque aut. Cupiditate ut quis qui omnis consequatur nesciunt ut.",
"due_date": null,
"done": false,
"done_at": null,
"assign_to": null,
"priority": "low",
"task_list_id": null,
"created_at": "2023-03-31T08:41:58+0000",
"updated_at": "2023-03-31T08:41:58+0000"
}
}
Received response:
Request failed with error:
Create a Task
requires authentication
Use this endpoint to create a Task data.
Assign a task to user
The best practice is using assign_to
. If you set assign_to, the API system doesn't look to
auto_assign_to_user
body params. If assign_to
is null or false and auto_assign_to_user
is true, the API system set assign_to the first company's owner (company_ids), if all companies
don't have owner, then check the contact's owner (contact_ids), then the deals.
Don't forget if you set auto_assign_to_user=true
, assign_to
must be null or false, and you
should send to API, company_ids, or contact_ids, or deal_ids.
Example request:
curl --request POST \
"https://api.hipcall.com/api/v20211124/tasks" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"Sent an email to client\",
\"description\": \"ut\",
\"due_date\": \"20220612 12:12:12\",
\"assign_to\": 1,
\"auto_assign_to_user\": false,
\"priority\": \"low\",
\"task_list\": 4,
\"contact_ids\": [
1,
2
],
\"company_ids\": [
1,
2
],
\"deal_ids\": [
1,
2
]
}"
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",
};
let body = {
"name": "Sent an email to client",
"description": "ut",
"due_date": "20220612 12:12:12",
"assign_to": 1,
"auto_assign_to_user": false,
"priority": "low",
"task_list": 4,
"contact_ids": [
1,
2
],
"company_ids": [
1,
2
],
"deal_ids": [
1,
2
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
'https://api.hipcall.com/api/v20211124/tasks',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'Sent an email to client',
'description' => 'ut',
'due_date' => '20220612 12:12:12',
'assign_to' => 1,
'auto_assign_to_user' => false,
'priority' => 'low',
'task_list' => 4,
'contact_ids' => [
1,
2,
],
'company_ids' => [
1,
2,
],
'deal_ids' => [
1,
2,
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
Received response:
Request failed with error:
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": "All users",
"user_case": "all",
"wrap_up_time": 5,
"strategy": "random",
"say_line_number": false,
"say_line_number_in_second": 120,
"callback": false,
"callback_dtmf": 0,
"callback_action": "none",
"state": "active"
},
{
"resource_type": "team",
"id": 2,
"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": "https://api.hipcall.com/api/v20211124/teams?page=1",
"last": "https://api.hipcall.com/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": "https://api.hipcall.com/api/v20211124/teams?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"path": "https://api.hipcall.com/api/v20211124/teams",
"per_page": 10,
"to": 2,
"total": 2
}
}
Received response:
Request failed with error:
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": "All users",
"user_case": "all",
"wrap_up_time": 5,
"strategy": "random",
"say_line_number": false,
"say_line_number_in_second": 120,
"callback": false,
"callback_dtmf": 0,
"callback_action": "none",
"state": "active"
}
}
Received response:
Request failed with error:
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": 2,
"email": "satya@microsoft.com",
"name": "Satya Nadella",
"full_name": "Satya Nadella",
"title": "",
"owner": false,
"locale": "en_GB",
"status": "active",
"default_number_id": 1,
"default_extension_id": 5,
"2fa": false,
"last_logged_in": "2023-04-11T09:06:42+0000",
"created_at": "2023-03-31T08:41:58+0000",
"updated_at": "2023-04-11T09:06:42+0000"
},
{
"resource_type": "user",
"id": 3,
"email": "mitchell.paula@example.com",
"name": "Holly James",
"full_name": "Holly James",
"title": "fuga",
"owner": false,
"locale": "en_GB",
"status": "active",
"default_number_id": null,
"default_extension_id": null,
"2fa": false,
"last_logged_in": "1998-07-21T23:07:12+0000",
"created_at": "2023-03-31T08:42:01+0000",
"updated_at": "2023-03-31T08:42:01+0000"
},
{
"resource_type": "user",
"id": 4,
"email": "walker.florence@example.org",
"name": "Muhammad Hill",
"full_name": "Muhammad Hill",
"title": "molestias",
"owner": false,
"locale": "en_GB",
"status": "active",
"default_number_id": null,
"default_extension_id": null,
"2fa": false,
"last_logged_in": "1995-04-07T03:17:22+0000",
"created_at": "2023-03-31T08:42:01+0000",
"updated_at": "2023-03-31T08:42:01+0000"
},
{
"resource_type": "user",
"id": 5,
"email": "cbennett@example.com",
"name": "Reece Stevens",
"full_name": "Reece Stevens",
"title": "assumenda",
"owner": false,
"locale": "en_GB",
"status": "active",
"default_number_id": null,
"default_extension_id": null,
"2fa": false,
"last_logged_in": null,
"created_at": "2023-03-31T08:42:01+0000",
"updated_at": "2023-03-31T08:42:01+0000"
},
{
"resource_type": "user",
"id": 6,
"email": "moore.jane@example.com",
"name": "Dan Reid",
"full_name": "Dan Reid",
"title": "maiores",
"owner": false,
"locale": "en_GB",
"status": "active",
"default_number_id": null,
"default_extension_id": null,
"2fa": false,
"last_logged_in": "1988-02-29T15:59:08+0000",
"created_at": "2023-03-31T08:42:01+0000",
"updated_at": "2023-03-31T08:42:01+0000"
},
{
"resource_type": "user",
"id": 7,
"email": "ava17@example.net",
"name": "Kelly Young",
"full_name": "Kelly Young",
"title": "et",
"owner": false,
"locale": "en_GB",
"status": "active",
"default_number_id": null,
"default_extension_id": null,
"2fa": false,
"last_logged_in": null,
"created_at": "2023-03-31T08:42:01+0000",
"updated_at": "2023-03-31T08:42:01+0000"
},
{
"resource_type": "user",
"id": 8,
"email": "lucas19@example.net",
"name": "Maria Evans",
"full_name": "Maria Evans",
"title": "sit",
"owner": false,
"locale": "en_GB",
"status": "active",
"default_number_id": null,
"default_extension_id": null,
"2fa": false,
"last_logged_in": "2003-08-20T12:07:54+0000",
"created_at": "2023-03-31T08:42:01+0000",
"updated_at": "2023-03-31T08:42:01+0000"
},
{
"resource_type": "user",
"id": 9,
"email": "uellis@example.com",
"name": "Yvette Wood",
"full_name": "Yvette Wood",
"title": "esse",
"owner": false,
"locale": "en_GB",
"status": "active",
"default_number_id": null,
"default_extension_id": null,
"2fa": false,
"last_logged_in": "1972-12-07T17:27:42+0000",
"created_at": "2023-03-31T08:42:01+0000",
"updated_at": "2023-03-31T08:42:01+0000"
},
{
"resource_type": "user",
"id": 10,
"email": "fchapman@example.org",
"name": "Rowena Matthews",
"full_name": "Rowena Matthews",
"title": "totam",
"owner": false,
"locale": "en_GB",
"status": "active",
"default_number_id": null,
"default_extension_id": null,
"2fa": false,
"last_logged_in": "1989-04-16T21:32:06+0000",
"created_at": "2023-03-31T08:42:01+0000",
"updated_at": "2023-03-31T08:42:01+0000"
},
{
"resource_type": "user",
"id": 11,
"email": "roxanne83@example.com",
"name": "Jim Rose",
"full_name": "Jim Rose",
"title": "porro",
"owner": false,
"locale": "en_GB",
"status": "active",
"default_number_id": null,
"default_extension_id": null,
"2fa": false,
"last_logged_in": null,
"created_at": "2023-03-31T08:42:01+0000",
"updated_at": "2023-03-31T08:42:01+0000"
}
],
"links": {
"first": "https://api.hipcall.com/api/v20211124/users?page=1",
"last": "https://api.hipcall.com/api/v20211124/users?page=3",
"prev": null,
"next": "https://api.hipcall.com/api/v20211124/users?page=2"
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 3,
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "https://api.hipcall.com/api/v20211124/users?page=1",
"label": "1",
"active": true
},
{
"url": "https://api.hipcall.com/api/v20211124/users?page=2",
"label": "2",
"active": false
},
{
"url": "https://api.hipcall.com/api/v20211124/users?page=3",
"label": "3",
"active": false
},
{
"url": "https://api.hipcall.com/api/v20211124/users?page=2",
"label": "Next »",
"active": false
}
],
"path": "https://api.hipcall.com/api/v20211124/users",
"per_page": 10,
"to": 10,
"total": 28
}
}
Received response:
Request failed with error:
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": "",
"owner": false,
"locale": "en_GB",
"default_number_id": 1,
"default_extension_id": 5,
"2fa": false,
"last_logged_in": "2023-04-11T09:06:42+0000",
"created_at": "2023-03-31T08:41:58+0000",
"updated_at": "2023-04-11T09:06:42+0000"
}
}
Received response:
Request failed with error:
Update an exist User
requires authentication
Use this endpoint to update an exist User's default number
Example request:
curl --request PUT \
"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: "PUT",
headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->put(
'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));
Received response:
Request failed with error: