HTTP Return Codes

This page describes the UnifiedAPI HTTP return codes and error responses.

Format

UnifiedAPI returns errors using a JSON format:

{
  "error": {
    "code": "error_code",
    "message": "Human readable error message."
  }
}

Successful Codes

HTTP Code	Description
200	The request was successful. The response body contains the requested resource.
204	The request was successful. There is no content to return.

Error Codes

400 Bad Request

Code	Message
cdr_start_date_invalid	The start date parameter is invalid. The format should be ISO ISO 8601 YYYY-MM-DDThh:mm:ss.
cdr_end_date_invalid	The end date parameter is invalid. The format should be ISO ISO 8601 YYYY-MM-DDThh:mm:ss.
cdr_source_invalid	The source parameter is invalid.
cdr_destination_invalid	The destination parameter is invalid.
cdr_flow_invalid	The flow parameter is invalid.
cdr_disposition_invalid	The disposition parameter is invalid.
cdr_save_start_date_invalid	The save start date parameter is invalid. The format should be ISO ISO 8601 YYYY-MM-DDThh:mm:ss.
cdr_save_end_date_invalid	The end start date parameter is invalid. The format should be ISO ISO 8601 YYYY-MM-DDThh:mm:ss.
cdr_invalid_date_parameters	The start date parameter is greater than end date parameter.
cdr_invalid_filter_by_answered	The filter by answered date parameter is invalid.
cdr_invalid_filter_by_published	The filter by published date parameter is invalid.
cdr_invalid_filter_by_source	The filter by source parameter is invalid.
cdr_invalid_filter_by_destination	The filter by destination parameter is invalid.
fields_invalid	Parameter fields is invalid.
count_invalid	Parameter count is invalid.
filterby_invalid	Parameter filterBy is invalid.
filterop_invalid	Parameter filterOp is invalid.
filtervalue_invalid	Parameter filterValue for onArray operation is invalid.
filtervalue_invalid	Parameter filterValue contains invalid numbers.
filtervalue_invalid	Parameter filterValue is invalid.
sortorder_invalid	Parameter sortOrder is invalid.
startindex_invalid	Parameter startIndex is invalid.
user_invalid	The user Id parameter is invalid.
extension_invalid	Invalid extension given in the URI-Fragment
fx_recipients_invalid	The recipients parmeter is invalid.
fx_approved_invalid	The approved parameter is invalid.
fx_file_invalid	One of the sent files are invalid.
fx_max_files_reached	The number of files that can be sent has been exceeded.
extension_invalid	Invalid extension given in the URI-Fragment
fx_upload_identifier_invalid	Invalid uploadIdentifier. Must be alphanumeric and maximum 32 characters.
pc_duration_invalid	Parameter callDuration is invalid.
pc_source_invalid	Parameter source is invalid.
pc_destination_invalid	Parameter destination is invalid.
pc_timeout_invalid	Parameter timeout is invalid.
pc_callerid_invalid	Parameter callerId is not valid.
pc_transfer_invalid	Parameter allowPublicTransfer is invalid.
pc_nonce_invalid	Parameter nonce is invalid.
pc_calleriddestination_invalid	Parameter callerIdDestination is not valid.
pc_calleecallerid_invalid	Parameter callerIdDestination is not valid.
pc_video_invalid	Parameter video is invalid.
pc_pin_invalid	Parameter conferencePin is invalid.
pc_number_invalid	Parameter conferencePin is invalid.
invalid_filter_by_published	The filter by published date is invalid.
invalid_filter_by_phone_call_id	The filter by phone call id is invalid.
pc_parktimeout_invalid	Parameter maxinparking is invalid.
pc_phonecall_invalid	The PhoneCall ID provided is invalid.
pc_phonecallview_invalid	The PhoneCall View ID provided is invalid.
pc_recformat_invalid	Parameter format is invalid.
pc_sendcallto_invalid	Parameter sendCallTo is invalid.
pc_transfer_from_number_invalid	Parameter transferFromNumber is invalid.
pc_transfer_number_invalid	Parameter transferNumber is invalid.
pc_private_invalid	Parameter private is invalid.
pc_private_invalid	The phone number is invalid.
pce_id_invalid	The id of the event is not valid.
pce_type_invalid	The type of the event is not valid.
pce_method_invalid	The request method is invalid.
pce_note_invalid	The note is invalid.
pce_url_invalid	The URL is invalid.
pce_status_invalid	The status is invalid.
status_invalid	The type of action performed is invalid.
qag_agent_invalid	The agent identifier is invalid.
qag_number_invalid	The agent phone number is invalid.
qag_fail_update	Failed to change the status.
qag_fail_update_number	Failed to change the agent number.
qag_cannot_update_number	Cannot modify the phone number for a local agent.

401 Unauthorized

Code	Message
unauthorized	Access unauthorized
expired_token	Token is expired or otherwise invalid.
access_denied	The token is invalid.

403 Forbidden

Code	Message
pce_access_denied	You are not allowed to manage Call Events.

500 Internal Server Error

Code	Message
internal_server_error	An internal server error occurred. Please contact the administrator.
pce_fail_add	Failed to add the event.
pce_fail_update	Failed to update the event.
pce_fail_delete	Failed to delete the event.

501 Not Implemented

Code	Message
not_implemented	The operation is not implemented.