Fetch Contact List Information
This API is based on UCAP module which returns the contact list based on the organization, category, contact status and contact created date. The details are as follows:
Client Contact ID
Contact Created Date
Endpoint
Method: GET
URL: /v1/contacts/info?orgid=&catid=&contactstatus=&contactdate=
Header Parameter
Authorization - Bearer <Token> Authorization - X-USER-ID
Query Parameter
Parameter Name | Mandatory/ Optional | Type | Description |
|---|---|---|---|
| Mandatory | Integer | Organization Id as query filter. |
| Mandatory | Integer | Category Id for which the client contact id and contact created date needs to be fetched. |
| Mandatory | String | The status of the call for which the client contact id and contact created date needs to be fetched. The status of the call is shown as completed, failed, or running. |
| Mandatory | Date (YYYY-MM-DD) | The date of the contact for which the client contact id and contact created date needs to be fetched. |
Sample Request
curl --location --request GET 'http://localhost:3130/v1/contacts/info?orgid=3&catid=6&contactstatus=failed&contactdate=2020-01-01' \ --header 'X-User-Id: 1' \ --header 'Authorization: Bearer 1234567890'
Sample Response
{
"org-id": 3,
"cat-id": 6,
"contact-created-date": "2020-01-01",
"contact-status": "failed",
"client-contact-details": [
{
"client-contact-id": "testredact110",
"client-contact-date": "2020-01-01T00:00:00Z"
},
{
"client-contact-id": "testredact109",
"client-contact-date": "2020-01-01T00:00:00Z"
},
{
"client-contact-id": "testredact108",
"client-contact-date": "2020-01-01T00:00:00Z"
}
]
}
Response and Error Codes
Code | Response |
|---|---|
200 | OK |
400 | {"error": " |
401 | {“reason”: "Authorization failed"} |
500 | Internal Server Error |