Skip to main content

Documentación

Communication Center Errors

This API documents the 200 response for each operation. The API can return the following errors instead. Errors use the same envelope as a successful response, with status.status set to ERROR and the code in status.error_code.

Errors for all communication center endpoints

Error Code

Message

UNAUTHENTICATED_API_CALL (HTTP 401)

The signature or access key is missing or not valid.

NOT_FOUND (HTTP 404)

The requested resource was not found.

INVALID_ORGANIZATION_ID

Missing header org_id to complete authentication.

GENERAL_ERROR

Contact Rapyd Client Support.

INTERNAL_SERVER_ERROR

Internal error. Please contact Rapyd Client Support.

Get all case communication threads

Error Code

Message

INVALID_FIELD - [ORDER_BY | DIRECTION | SKIP | LIMIT]

A query parameter is not valid. The code names the parameter. order_by must be created_at or updated_at. direction must be asc or desc. skip must be 0 or more. limit must be from 1 to 100.

Get case communication thread

Error Code

Message

INVALID_FIELD - [ORDER_BY | DIRECTION | SKIP | LIMIT | MESSAGE_DIRECTION]

A query parameter is not valid. The code names the parameter. message_direction must be incoming or outgoing. The other parameters follow the same rules as in Get All Case Communication Threads.

ERROR_GET_COMMUNICATION

The communication thread was not found. The request was rejected. Corrective action: For the thread_token path parameter, use the token of a valid thread, a string starting with comm_.

ERROR_COMMUNICATION_DOES_NOT_EXIST

Explanation: The communication thread does not exist.

Add message to case communication thread

Error Code

Message

INVALID_FIELD - [CONTENT | ATTACHMENTS]

A value is not valid. content is required and can be up to 1024 characters. attachments can contain up to 5 items.

ERROR_ATTACHED_FILES_SHOULDBE_ARRAY

Explanation: attachments must be an array.

ERROR_GET_COMMUNICATION

The communication thread was not found. The request was rejected. Corrective action: For the thread_token path parameter, use the token of a valid thread, a string starting with comm_.

ERROR_ADD_COMMUNICATION_MESSAGE

Explanation: The message could not be added to the thread.

Upload file to communication center

Error Code

Message

ERROR_UPLOAD_FILE_UNSUPPORTED_FILE_TYPE

The request tried to upload a file, but the file type was not supported. The request was rejected. Corrective action: Upload a file that is of a supported file type.

ERROR_TOO_MANY_FILES_IN_UPLOAD_REQUEST

The request attempted to upload multiple document files, but it includes too many files. The request was rejected. Corrective action: Lower the number of files in the request and resend it.

ERROR_UPLOAD_FILE_SIZE_TO_LARGE

The file size is too large.

ERROR_NAME_OF_DOCUMENT_IS_TOO_LONG

The request attempted to upload a document, but the document's file name is too long. The request was rejected. Corrective action: Rename the file according to the length limitation.

ERROR_UPLOAD_FILE

Internal error upload file. Please contact Rapyd Client Support.

Download file

Error Code

Message

ERROR_GET_COMMUNICATION

The communication thread was not found. The request was rejected. Corrective action: For the thread_token path parameter, use the token of a valid thread, a string starting with comm_.

ERROR_GET_MESSAGE_ATTACHMENT

Explanation: The attachment could not be retrieved.