Search…
Geographic
get
https://voicetrends.plumvoice.com
/api/profile/{start}/{end}/{phone}
Caller Profile Data

Possible Response Codes

  • 200: success, data successfully returned.
  • 400: supplied data improperly formatted or invalid
  • 401: authentication parameters invalid or the account is inactive
  • 405: invalid HTTP method supplied (only POST allowed)
  • 429: rate limit exceeded
  • 500: unknown error
The return structure will contain the following item(s):
Name
Data Type
Always Present
Description
error
string
no
Indicates what went wrong when an HTTP code other than 200 is returned.
US
array
no
A 200 HTTP code returns this value, the list of US locations and their associated call count.
NON_US
array
no
A 200 HTTP code returns this value, the list of non-US locations and their associated call count.

Sample Code

This sample code makes a request to authenticate an account using PHP, but any language capable of integrating with a REST API works for this type of request:
<?php
// authentication and filter settings
$login = '<your_temporary_login>';
$password = '<your_temporary_password>';
$start = '<start_date>';
$end = '<end_date>';
$phone = '<selected_phone_number>';
// build the URL
$url = 'https://voicetrends.plumvoice.com/api/performance/'.$start.'/'.$end.'/'.$phone;
$ch = curl_init();
curl_setopt($ch, CURLOPT_USERPWD, $login.':'.$password);
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_HTTPHEADER, array("Accept: application/json"));
$result = curl_exec($ch);
$http_code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
var_dump($result);
var_dump($http_code);