Metadata
The MediaVault API offers multiple endpoints to retrieve metadata based on various identifiers. You can access metadata using a reference ID, session ID, master ID, or call ID. Additionally, metadata can be retrieved based on custom fields or through a search query built with key-value pairs. These endpoints provide flexibility in managing and retrieving metadata within your application.
GET /metadata/by-reference/{ref_id}
Retrieve metadata based on reference_id / session_id / master_id
Required Parameters
ref_id string
reference_id / session_id / master_id of the associated metadata
Request
curl -X 'GET' \
'https://api.mediavaultplus.com/metadata/by-reference/131604421973' \
-H 'accept: application/json'
Response
{
"isError": false,
"errorMessage": null,
"data": [
{
"datetime": "2024-01-01T00:00:00",
"ani": null,
"dnis": null,
"agent": null,
"agent_name": null,
"campaign_type": null,
"campaign": null,
"call_type": null,
"call_id": null,
"ref_id": null,
"campaign_id": null,
"skill_id": null,
"handle_time": null,
"talk_time": null,
"agent_group_id": null,
"disposition_id": null,
"ani_state": null,
"dnis_state": null,
"skill": null,
"agent_group": null,
"disposition": null,
"disposition_notes": null,
"recordings": null,
"customer_first_name": null,
"customer_middle_name": null,
"customer_last_name": null,
"customer_email": null,
"phone_number1": null,
"phone_number2": null,
"phone_number3": null,
"country": null,
"state_id": null,
"zip": null,
"street": null,
"city": null,
"dest_agent_name": null,
"lead_id": null,
"ivr_path": null,
"media": null,
"company": null,
"transcript": null,
"custom_field_1": null,
"custom_field_2": null,
"custom_field_3": null,
"custom_field_4": null,
"custom_field_5": null,
"custom_field_6": null,
"custom_field_7": null,
"custom_field_8": null,
"custom_field_9": null,
"custom_field_10": null,
"custom_field_11": null,
"custom_field_12": null,
"custom_field_13": null,
"custom_field_14": null,
"custom_field_15": null,
"custom_field_16": null,
"custom_field_17": null,
"custom_field_18": null,
"custom_field_19": null,
"custom_field_20": null,
"security_field_01": null,
"security_field_02": null,
"security_field_03": null,
"security_field_04": null,
"security_field_05": null,
"notes": null
},
{
"datetime": "2024-01-01T00:00:00",
"ani": null,
"dnis": null,
"agent": null,
"agent_name": null,
"campaign_type": null,
"campaign": null,
"call_type": null,
"call_id": null,
"ref_id": null,
"campaign_id": null,
"skill_id": null,
"handle_time": null,
"talk_time": null,
"agent_group_id": null,
"disposition_id": null,
"ani_state": null,
"dnis_state": null,
"skill": null,
"agent_group": null,
"disposition": null,
"disposition_notes": null,
"recordings": null,
"customer_first_name": null,
"customer_middle_name": null,
"customer_last_name": null,
"customer_email": null,
"phone_number1": null,
"phone_number2": null,
"phone_number3": null,
"country": null,
"state_id": null,
"zip": null,
"street": null,
"city": null,
"dest_agent_name": null,
"lead_id": null,
"ivr_path": null,
"media": null,
"company": null,
"transcript": null,
"custom_field_1": null,
"custom_field_2": null,
"custom_field_3": null,
"custom_field_4": null,
"custom_field_5": null,
"custom_field_6": null,
"custom_field_7": null,
"custom_field_8": null,
"custom_field_9": null,
"custom_field_10": null,
"custom_field_11": null,
"custom_field_12": null,
"custom_field_13": null,
"custom_field_14": null,
"custom_field_15": null,
"custom_field_16": null,
"custom_field_17": null,
"custom_field_18": null,
"custom_field_19": null,
"custom_field_20": null,
"security_field_01": null,
"security_field_02": null,
"security_field_03": null,
"security_field_04": null,
"security_field_05": null,
"notes": null
},
{
"datetime": "2024-01-01T00:00:00",
"ani": null,
"dnis": null,
"agent": null,
"agent_name": null,
"campaign_type": null,
"campaign": null,
"call_type": null,
"call_id": null,
"ref_id": null,
"campaign_id": null,
"skill_id": null,
"handle_time": null,
"talk_time": null,
"agent_group_id": null,
"disposition_id": null,
"ani_state": null,
"dnis_state": null,
"skill": null,
"agent_group": null,
"disposition": null,
"disposition_notes": null,
"recordings": null,
"customer_first_name": null,
"customer_middle_name": null,
"customer_last_name": null,
"customer_email": null,
"phone_number1": null,
"phone_number2": null,
"phone_number3": null,
"country": null,
"state_id": null,
"zip": null,
"street": null,
"city": null,
"dest_agent_name": null,
"lead_id": null,
"ivr_path": null,
"media": null,
"company": null,
"transcript": null,
"custom_field_1": null,
"custom_field_2": null,
"custom_field_3": null,
"custom_field_4": null,
"custom_field_5": null,
"custom_field_6": null,
"custom_field_7": null,
"custom_field_8": null,
"custom_field_9": null,
"custom_field_10": null,
"custom_field_11": null,
"custom_field_12": null,
"custom_field_13": null,
"custom_field_14": null,
"custom_field_15": null,
"custom_field_16": null,
"custom_field_17": null,
"custom_field_18": null,
"custom_field_19": null,
"custom_field_20": null,
"security_field_01": null,
"security_field_02": null,
"security_field_03": null,
"security_field_04": null,
"security_field_05": null,
"notes": null
}
]
}GET /metadata/by-call-id/{call_id}
Retrieve metadata based on call_id
Required Parameters
call_id string
call_id of the associated metadata
Request
curl -X 'GET' \
'https://api.mediavaultplus.com/metadata/by-call-id/131604421973' \
-H 'accept: application/json'
Response
{
"isError": false,
"errorMessage": null,
"data": [
{
"datetime": "2024-01-01T00:00:00",
"ani": null,
"dnis": null,
"agent": null,
"agent_name": null,
"campaign_type": null,
"campaign": null,
"call_type": null,
"call_id": null,
"ref_id": null,
"campaign_id": null,
"skill_id": null,
"handle_time": null,
"talk_time": null,
"agent_group_id": null,
"disposition_id": null,
"ani_state": null,
"dnis_state": null,
"skill": null,
"agent_group": null,
"disposition": null,
"disposition_notes": null,
"recordings": null,
"customer_first_name": null,
"customer_middle_name": null,
"customer_last_name": null,
"customer_email": null,
"phone_number1": null,
"phone_number2": null,
"phone_number3": null,
"country": null,
"state_id": null,
"zip": null,
"street": null,
"city": null,
"dest_agent_name": null,
"lead_id": null,
"ivr_path": null,
"media": null,
"company": null,
"transcript": null,
"custom_field_1": null,
"custom_field_2": null,
"custom_field_3": null,
"custom_field_4": null,
"custom_field_5": null,
"custom_field_6": null,
"custom_field_7": null,
"custom_field_8": null,
"custom_field_9": null,
"custom_field_10": null,
"custom_field_11": null,
"custom_field_12": null,
"custom_field_13": null,
"custom_field_14": null,
"custom_field_15": null,
"custom_field_16": null,
"custom_field_17": null,
"custom_field_18": null,
"custom_field_19": null,
"custom_field_20": null,
"security_field_01": null,
"security_field_02": null,
"security_field_03": null,
"security_field_04": null,
"security_field_05": null,
"notes": null
},
{
"datetime": "2024-01-01T00:00:00",
"ani": null,
"dnis": null,
"agent": null,
"agent_name": null,
"campaign_type": null,
"campaign": null,
"call_type": null,
"call_id": null,
"ref_id": null,
"campaign_id": null,
"skill_id": null,
"handle_time": null,
"talk_time": null,
"agent_group_id": null,
"disposition_id": null,
"ani_state": null,
"dnis_state": null,
"skill": null,
"agent_group": null,
"disposition": null,
"disposition_notes": null,
"recordings": null,
"customer_first_name": null,
"customer_middle_name": null,
"customer_last_name": null,
"customer_email": null,
"phone_number1": null,
"phone_number2": null,
"phone_number3": null,
"country": null,
"state_id": null,
"zip": null,
"street": null,
"city": null,
"dest_agent_name": null,
"lead_id": null,
"ivr_path": null,
"media": null,
"company": null,
"transcript": null,
"custom_field_1": null,
"custom_field_2": null,
"custom_field_3": null,
"custom_field_4": null,
"custom_field_5": null,
"custom_field_6": null,
"custom_field_7": null,
"custom_field_8": null,
"custom_field_9": null,
"custom_field_10": null,
"custom_field_11": null,
"custom_field_12": null,
"custom_field_13": null,
"custom_field_14": null,
"custom_field_15": null,
"custom_field_16": null,
"custom_field_17": null,
"custom_field_18": null,
"custom_field_19": null,
"custom_field_20": null,
"security_field_01": null,
"security_field_02": null,
"security_field_03": null,
"security_field_04": null,
"security_field_05": null,
"notes": null
},
{
"datetime": "2024-01-01T00:00:00",
"ani": null,
"dnis": null,
"agent": null,
"agent_name": null,
"campaign_type": null,
"campaign": null,
"call_type": null,
"call_id": null,
"ref_id": null,
"campaign_id": null,
"skill_id": null,
"handle_time": null,
"talk_time": null,
"agent_group_id": null,
"disposition_id": null,
"ani_state": null,
"dnis_state": null,
"skill": null,
"agent_group": null,
"disposition": null,
"disposition_notes": null,
"recordings": null,
"customer_first_name": null,
"customer_middle_name": null,
"customer_last_name": null,
"customer_email": null,
"phone_number1": null,
"phone_number2": null,
"phone_number3": null,
"country": null,
"state_id": null,
"zip": null,
"street": null,
"city": null,
"dest_agent_name": null,
"lead_id": null,
"ivr_path": null,
"media": null,
"company": null,
"transcript": null,
"custom_field_1": null,
"custom_field_2": null,
"custom_field_3": null,
"custom_field_4": null,
"custom_field_5": null,
"custom_field_6": null,
"custom_field_7": null,
"custom_field_8": null,
"custom_field_9": null,
"custom_field_10": null,
"custom_field_11": null,
"custom_field_12": null,
"custom_field_13": null,
"custom_field_14": null,
"custom_field_15": null,
"custom_field_16": null,
"custom_field_17": null,
"custom_field_18": null,
"custom_field_19": null,
"custom_field_20": null,
"security_field_01": null,
"security_field_02": null,
"security_field_03": null,
"security_field_04": null,
"security_field_05": null,
"notes": null
}
]
}POST /metadata/by-custom-fields
Retrieve metadata based on custom/security fields
Required Parameters
pageIndex integer
Page Index for the list of records returned. Default page size is 50
startDate string
Start date to filter the metadata
endDate string
End date to filter the metadata
Request
curl -X 'POST' \
'https://api.mediavaultplus.com/metadata/by-custom-fields?pageIndex=1&startDate=2024-01-01&endDate=2024-01-07' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"custom_field_1": "string",
"custom_field_2": "string",
"custom_field_3": "string"
}'
Response
{
"isError": false,
"errorMessage": null,
"pageID": 1,
"recordCount": 3,
"data": [
{
"datetime": "2024-10-17T08:10:24.2933204-05:00",
"ani": null,
"dnis": null,
"agent": null,
"agent_name": null,
"campaign_type": null,
"campaign": null,
"call_type": null,
"call_id": null,
"ref_id": null,
"campaign_id": null,
"skill_id": null,
"handle_time": null,
"talk_time": null,
"agent_group_id": null,
"disposition_id": null,
"ani_state": null,
"dnis_state": null,
"skill": null,
"agent_group": null,
"disposition": null,
"disposition_notes": null,
"recordings": null,
"customer_first_name": null,
"customer_middle_name": null,
"customer_last_name": null,
"customer_email": null,
"phone_number1": null,
"phone_number2": null,
"phone_number3": null,
"country": null,
"state_id": null,
"zip": null,
"street": null,
"city": null,
"dest_agent_name": null,
"lead_id": null,
"ivr_path": null,
"media": null,
"company": null,
"transcript": null,
"custom_field_1": null,
"custom_field_2": null,
"custom_field_3": null,
"custom_field_4": null,
"custom_field_5": null,
"custom_field_6": null,
"custom_field_7": null,
"custom_field_8": null,
"custom_field_9": null,
"custom_field_10": null,
"custom_field_11": null,
"custom_field_12": null,
"custom_field_13": null,
"custom_field_14": null,
"custom_field_15": null,
"custom_field_16": null,
"custom_field_17": null,
"custom_field_18": null,
"custom_field_19": null,
"custom_field_20": null,
"security_field_01": null,
"security_field_02": null,
"security_field_03": null,
"security_field_04": null,
"security_field_05": null,
"notes": null
},
{
"datetime": "2024-10-17T08:10:24.2933215-05:00",
"ani": null,
"dnis": null,
"agent": null,
"agent_name": null,
"campaign_type": null,
"campaign": null,
"call_type": null,
"call_id": null,
"ref_id": null,
"campaign_id": null,
"skill_id": null,
"handle_time": null,
"talk_time": null,
"agent_group_id": null,
"disposition_id": null,
"ani_state": null,
"dnis_state": null,
"skill": null,
"agent_group": null,
"disposition": null,
"disposition_notes": null,
"recordings": null,
"customer_first_name": null,
"customer_middle_name": null,
"customer_last_name": null,
"customer_email": null,
"phone_number1": null,
"phone_number2": null,
"phone_number3": null,
"country": null,
"state_id": null,
"zip": null,
"street": null,
"city": null,
"dest_agent_name": null,
"lead_id": null,
"ivr_path": null,
"media": null,
"company": null,
"transcript": null,
"custom_field_1": null,
"custom_field_2": null,
"custom_field_3": null,
"custom_field_4": null,
"custom_field_5": null,
"custom_field_6": null,
"custom_field_7": null,
"custom_field_8": null,
"custom_field_9": null,
"custom_field_10": null,
"custom_field_11": null,
"custom_field_12": null,
"custom_field_13": null,
"custom_field_14": null,
"custom_field_15": null,
"custom_field_16": null,
"custom_field_17": null,
"custom_field_18": null,
"custom_field_19": null,
"custom_field_20": null,
"security_field_01": null,
"security_field_02": null,
"security_field_03": null,
"security_field_04": null,
"security_field_05": null,
"notes": null
},
{
"datetime": "2024-10-17T08:10:24.2933225-05:00",
"ani": null,
"dnis": null,
"agent": null,
"agent_name": null,
"campaign_type": null,
"campaign": null,
"call_type": null,
"call_id": null,
"ref_id": null,
"campaign_id": null,
"skill_id": null,
"handle_time": null,
"talk_time": null,
"agent_group_id": null,
"disposition_id": null,
"ani_state": null,
"dnis_state": null,
"skill": null,
"agent_group": null,
"disposition": null,
"disposition_notes": null,
"recordings": null,
"customer_first_name": null,
"customer_middle_name": null,
"customer_last_name": null,
"customer_email": null,
"phone_number1": null,
"phone_number2": null,
"phone_number3": null,
"country": null,
"state_id": null,
"zip": null,
"street": null,
"city": null,
"dest_agent_name": null,
"lead_id": null,
"ivr_path": null,
"media": null,
"company": null,
"transcript": null,
"custom_field_1": null,
"custom_field_2": null,
"custom_field_3": null,
"custom_field_4": null,
"custom_field_5": null,
"custom_field_6": null,
"custom_field_7": null,
"custom_field_8": null,
"custom_field_9": null,
"custom_field_10": null,
"custom_field_11": null,
"custom_field_12": null,
"custom_field_13": null,
"custom_field_14": null,
"custom_field_15": null,
"custom_field_16": null,
"custom_field_17": null,
"custom_field_18": null,
"custom_field_19": null,
"custom_field_20": null,
"security_field_01": null,
"security_field_02": null,
"security_field_03": null,
"security_field_04": null,
"security_field_05": null,
"notes": null
}
]
}POST /metadata/search
Retrieve metadata based on search query, built using param as key-value pair
Required Parameters
pageIndex integer
Page Index for the list of records returned. Default page size is 50
startDate string
Start date to filter the metadata
endDate string
End date to filter the metadata
Request
curl -X 'POST' \
'https://api.mediavaultplus.com/metadata/search?pageIndex=1&startDate=2024-01-01&endDate=2024-01-07' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"custom_field_1": "string",
"custom_field_2": "string",
"custom_field_3": "string"
}'
Response
{
"isError": false,
"errorMessage": null,
"data": [
{
"datetime": "2024-10-17T08:10:24.2953518-05:00",
"ani": null,
"dnis": null,
"agent": null,
"agent_name": null,
"campaign_type": null,
"campaign": null,
"call_type": null,
"call_id": null,
"ref_id": null,
"campaign_id": null,
"skill_id": null,
"handle_time": null,
"talk_time": null,
"agent_group_id": null,
"disposition_id": null,
"ani_state": null,
"dnis_state": null,
"skill": null,
"agent_group": null,
"disposition": null,
"disposition_notes": null,
"recordings": null,
"customer_first_name": null,
"customer_middle_name": null,
"customer_last_name": null,
"customer_email": null,
"phone_number1": null,
"phone_number2": null,
"phone_number3": null,
"country": null,
"state_id": null,
"zip": null,
"street": null,
"city": null,
"dest_agent_name": null,
"lead_id": null,
"ivr_path": null,
"media": null,
"company": null,
"transcript": null,
"custom_field_1": null,
"custom_field_2": null,
"custom_field_3": null,
"custom_field_4": null,
"custom_field_5": null,
"custom_field_6": null,
"custom_field_7": null,
"custom_field_8": null,
"custom_field_9": null,
"custom_field_10": null,
"custom_field_11": null,
"custom_field_12": null,
"custom_field_13": null,
"custom_field_14": null,
"custom_field_15": null,
"custom_field_16": null,
"custom_field_17": null,
"custom_field_18": null,
"custom_field_19": null,
"custom_field_20": null,
"security_field_01": null,
"security_field_02": null,
"security_field_03": null,
"security_field_04": null,
"security_field_05": null,
"notes": null
},
{
"datetime": "2024-10-17T08:10:24.295353-05:00",
"ani": null,
"dnis": null,
"agent": null,
"agent_name": null,
"campaign_type": null,
"campaign": null,
"call_type": null,
"call_id": null,
"ref_id": null,
"campaign_id": null,
"skill_id": null,
"handle_time": null,
"talk_time": null,
"agent_group_id": null,
"disposition_id": null,
"ani_state": null,
"dnis_state": null,
"skill": null,
"agent_group": null,
"disposition": null,
"disposition_notes": null,
"recordings": null,
"customer_first_name": null,
"customer_middle_name": null,
"customer_last_name": null,
"customer_email": null,
"phone_number1": null,
"phone_number2": null,
"phone_number3": null,
"country": null,
"state_id": null,
"zip": null,
"street": null,
"city": null,
"dest_agent_name": null,
"lead_id": null,
"ivr_path": null,
"media": null,
"company": null,
"transcript": null,
"custom_field_1": null,
"custom_field_2": null,
"custom_field_3": null,
"custom_field_4": null,
"custom_field_5": null,
"custom_field_6": null,
"custom_field_7": null,
"custom_field_8": null,
"custom_field_9": null,
"custom_field_10": null,
"custom_field_11": null,
"custom_field_12": null,
"custom_field_13": null,
"custom_field_14": null,
"custom_field_15": null,
"custom_field_16": null,
"custom_field_17": null,
"custom_field_18": null,
"custom_field_19": null,
"custom_field_20": null,
"security_field_01": null,
"security_field_02": null,
"security_field_03": null,
"security_field_04": null,
"security_field_05": null,
"notes": null
},
{
"datetime": "2024-10-17T08:10:24.2953533-05:00",
"ani": null,
"dnis": null,
"agent": null,
"agent_name": null,
"campaign_type": null,
"campaign": null,
"call_type": null,
"call_id": null,
"ref_id": null,
"campaign_id": null,
"skill_id": null,
"handle_time": null,
"talk_time": null,
"agent_group_id": null,
"disposition_id": null,
"ani_state": null,
"dnis_state": null,
"skill": null,
"agent_group": null,
"disposition": null,
"disposition_notes": null,
"recordings": null,
"customer_first_name": null,
"customer_middle_name": null,
"customer_last_name": null,
"customer_email": null,
"phone_number1": null,
"phone_number2": null,
"phone_number3": null,
"country": null,
"state_id": null,
"zip": null,
"street": null,
"city": null,
"dest_agent_name": null,
"lead_id": null,
"ivr_path": null,
"media": null,
"company": null,
"transcript": null,
"custom_field_1": null,
"custom_field_2": null,
"custom_field_3": null,
"custom_field_4": null,
"custom_field_5": null,
"custom_field_6": null,
"custom_field_7": null,
"custom_field_8": null,
"custom_field_9": null,
"custom_field_10": null,
"custom_field_11": null,
"custom_field_12": null,
"custom_field_13": null,
"custom_field_14": null,
"custom_field_15": null,
"custom_field_16": null,
"custom_field_17": null,
"custom_field_18": null,
"custom_field_19": null,
"custom_field_20": null,
"security_field_01": null,
"security_field_02": null,
"security_field_03": null,
"security_field_04": null,
"security_field_05": null,
"notes": null
}
]
}