Pull API - Using Phonon UUID | API Documentation
- Abhinandan Shah (Deactivated)
- Niharika Shetty
- Former user (Deleted)
- 1 Pull API - Using Phonon UUID
- 1.1 Request Parameters:
- 1.1.1 Request Payload:
- 1.1.2 Sample Request:
- 1.2 Pull API Version 2.0
- 1.2.1 Request Payload:
- 1.2.2 Sample Request:
- 1.3 Response Parameters:
- 1.1 Request Parameters:
Pull API - Using Phonon UUID
Use the Pull API to get the details for one or more Phonon UUIDs after the call is over.
Before sending the request, make sure to whitelist your IP through which you are sending API request in the whitelist section.
Request Parameters:
Method | POST |
|---|---|
Body | JSON |
Headers | Content-Type: application/json |
Auth | None |
URL | Please contact your Customer Success Manager for the URL |
Request Payload:
{
"phonon-uuids": [
{"<36 character alphanumeric Phonon UUID>"},
{"<36 character alphanumeric Phonon UUID>"},
...
],
"fetch-attempt": "ALL" // ALL = Fetch all attempts; LAST = Fetch only last attempt
}Sample Request:
{
"phonon-uuids": [
"b2f9909e-9ac4-4e5c-9ac8-183f24ea9436"
],
"fetch-attempt": "ALL"
}The Pull API has now been updated to take additional parameters in the Request Payload in the new version of the Pull API URL. This is done to ensure an additional layer of authentication or security step.
Please contact your Customer Success Manager for the updated URL.
Pull API Version 2.0
Request Payload:
{
"security-id": "<64 character alphanumeric Security ID>",
"flow-id": "<8 character alphanumeric Flow ID>",
"phonon-uuids": [
{"<36 character alphanumeric Phonon UUID>"},
{"<36 character alphanumeric Phonon UUID>"},
...
],
"fetch-attempt": "ALL" // ALL = Fetch all attempts; LAST = Fetch only last attempt
}Sample Request:
Â
Notes:
Ensure valid JSON format
Ensure IP is Whitelisted in your account
Ensure your account validity is not expired
Ensure number of Phonon UUIDs is less than Max data size (200 UUIDs is current max limit) - Response will contain api-response-message as ‘Max Data List Size Exceeded’ and no result will be fetched.
Response Parameters:
If there’s no data available:
Data Response Schema:
Â
This document has been developed by Phonon.io for the sole and exclusive use of the customer / prospective customer with whom this document is being shared. Further, this document has been provided by Phonon.io to the recipient in good faith and based on request from the recipient for the same. This document is a confidential document and contains confidential product technology, workflow and commercial details that are for the sole usage of the intended recipients of this document. Recipients are advised not to share this document with any third party that is not the intended recipient of this document and neither to bring this document in full or parts into the public domain. Any unauthorized access may be brought to Phonon.io’s notice immediately. Phonon.io is free to take any legal action it deems necessary against any person or entity that violates this confidentiality agreement. Phonon.io is bound and governed by the rules of the state of Gujarat in India. In case you are not in agreement with the terms set in this clause or are not an intended recipient of this document, please destroy the document and intimate us of the same at info@phonon.io.