Geographic
- NEW! - Interactive API docs, now live!
Visit api-docs.plumvoice.com to read Plum API documentation, build and test requests in our interactive API sandbox, review the responses, and share it all with your team.
Caller Profile Data
GET
https://voicetrends.plumvoice.com/api/profile/{start}/{end}/{phone}
This service fetches any of the available data in the Caller Profile/Geographic page in VoiceTrends. To use this service, provide your temporary authentication credentials and several GET parameters, which function as filters for this data. This API is rate-limited in a group with all other raw data resources to 150 requests per 15-minute window.
Path Parameters
Name | Type | Description |
---|---|---|
start | integer | The start date (inclusive) for this request in YYYYMMDD format. |
end | integer | The end date (inclusive) for this request in YYYYMMDD format. |
phone | string | The single phone number for this report or “ALL” to merge data across all numbers. |
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:
Last updated