RESTful Contact Management Interface (CMI)

This interface provides access to conversations and related information, including script results and call recordings stored in the database.


Resource	Request method	Object: required rights
/emails	GET	Email queue: Manage contact history or User: Manage contact history This is the agent to whom the email is allocated.
/emails/{emailId}	GET
/scriptResults	GET	One of the following: Queue: Manage contact history User: Manage contact history Outbound customer: View
/scriptResults	POST
/scriptResults/{scriptResultId}	GET
/chats	GET	Chat queue: Manage contact history or User: Manage contact history This is the agent to whom the chat is allocated.
/chats	POST
/chats/{chatsId}	GET
/callRecordings	GET	Phone queue: Listen to recording
/callRecordings/{callRecordingId}
/callRecordings/{callRecordingId}/listenLog
/callRecordings/{callRecordingId}/listenLog	POST
/callbacks	GET	Callbacks: View
/callbacks	POST	Callbacks: Create
/callbacks/{callbackId}	GET	Callbacks: View
/callbacks/{callbackId}	PUT	Callbacks: Modify
/contacts	GET	Queue/user/campaign/IVR: Statistics details
/contacts/{contactId}
/contacts/{contactId}/details
/contacts/{contactId}/remarks
	POST
	PUT
/contactData	GET	Queue/user/custom IVR: Statistics details
/contactData	POST	Queue/user: Statistics details and Manage contact history
/contactData/{contactId}	GET	Queue/user/custom IVR: Statistics details
/messages	GET	Queue: Messaging
/messages	POST
/messages/{messageId}	GET
	PUT
	DELETE
/customerConsents	GET	Customer consents: View
/customerConsents	POST	Customer consents: Create
/customerConsents/{usage}_{address}	GET	Customer consents: View
/customerConsents/{usage}_{address}	DELETE	Customer consents: View and Delete
/callTranscripts	GET	Queue/user/campaign: Listen to recording or The recording agent must be the user themselves.
/callTranscripts	POST	User Service: Save call transcript, and Queue/user/campaign: Listen to recording or The recording agent must be the user themselves.
/callTranscripts/{callTranscriptId}	GET	Queue/user/campaign: Listen to recording or The recording agent must be the user themselves.
/callTranscripts/{callTranscriptId}	PUT	User Service: Save call transcript, and Queue/user/campaign: Listen to recording or The recording agent must be the user themselves.