Resolver integration

Resolver is an organisation that offers a free complaint resolution platform for consumers, and a paid-for suite of modules for businesses. If you are an iCasework or UsefulFeedback customer and are already using our best of breed complaints management tools, you can add value to your Resolver implementation by linking Resolver to your iCasework / UsefulFeedback instance to ensure that cases routed through Resolver are managed and can be reported alongside cases coming in via other channels such as your contact centre, self service forms and direct email.

How it works

Your UsefulFeedback system includes a suite of APIs that can be triggered directly from Resolver to raise and escalate complaint cases. You will need to contact your Resolver for Business account manager in order to use this functionality from Resolver - the functionality is driven by your Resolver instance triggering iCasework APIs. Below is an example set of API details for a Resolver integration. Please contact your iCasework account or project manager to arrange any iCasework configuration work required to utilise the iCasework Resolver integration on your system.

Create case

Cases can be created from Resolver directly into UsefulFeedback using the CreateCase API. CreateCase is a POST HTTPS request with a JSON/XML/POST parameter payload. Upon a successful call a new case will be created in iCasework.

The API request

The endpoint URL for the API is as follows:

UAT: https://uat.icasework.com/createcase?db=<YourId>

Live: https://<YourId>.icasework.com/createcase

Authentication

You can authenticate the request by using OAuth2 based authentication, which is discussed in the iCasework API documentation.

Parameters

Parameters in the request can be passed as a JSON/XML payload in the request body or as POST parameters in the request. The following are the parameters required for a successful request.

NameValueDescription
Type"Complaint"The UsefulFeedback case type to create a complaint case.
RequestMethod"Resolver"How the complaint was received into the iCasework UsefulFeedback system.
RequestDateYYYY-MM-DDThe date the complaint was received.
RequestIdID valueMapped to unique ResolverReference. This will ensure both system’s IDs are in sync to allow easy case update from Resolver.
Format"XML" / "JSON"Preferred response format.
MenuContextService CodeCode relating to the iCasework top level classification for the Complaint. Please refer to your system administrator, project manager or raise a support request for more information.
DetailsTextDetails of the complaint
ActionRequestedTextDetails of how the customer would like the case to be resolved
Customer.TitleText
Customer.FirstNameText
Customer.SurnameText
Customer.AddressText
Customer.TownText
Customer.CountyText
Customer.PostcodePostcode
Customer.ContactMethod"Resolver"Ensures that responses will be routed via the Resolver case
Customer.EmailEmail
Customer.PhonePhone number
Customer.MobilePhone number
Customer.CaseEmailEmailResolver's unique response address for the case
ExternalIdID valueAny reference or ID that should be recorded against the iCasework case (other than the unique Resolver ID).


Attachments can be uploaded to iCasework using the following additional parameters. The process assumes that documents will be available at a URL controlled by Resolver to either link to, or upload from. We do not support direct post of binary document data to this API.

NameValueDescription
Document1.NameCharacter (100)Name of the attached file
Document1.MimeTypeCharacter (100)Mime type of the attached file
Document1.URLCharacter (500)URL of the attached file
Document1.URLLoadContentBoolean

If True, a callback will try to retrieve the file from the URL given during submission of the web service and load it into your system. If False, the case will be created with a link to the file URL.

Example post


https://uat.icasework.com/createcase?db=<your_system_id>&access_token=<access_token>&Format=json


{

"Type":"Complaint",

"RequestDate":"2018-11-10",

"RequestMethod":"Resolver",

"RequestId":"[ResolverId]",

"MenuContext":"Housing",

"Details":"This is the problem",

"Customer.Title":"Mr",

"Customer.FirstName":"Ronan",

"Customer.Surname":"Keating",

"Customer.Address":"32 Somewhere Street, Ipswich",

"Customer.Email":"test@test.com",

"Customer.Phone":"0203 00333023",

"Customer.Mobile":"07700900571"

"Case.Email":"[Resolver Unique Email Address]",

}

Response

Depending on the format selected in the request, a successful response should look like the below, returning the ID of the newly created case. In the case of a failed request, the standard HTTPS response codes are used, with the X-Application-Error-Info giving more information about the cause of the error.


XML

<createcaseresponse>

    <caseid>308332</caseid>

    <team>INBOX</team>

</createcaseresponse>


JSON  

{

    "caseid": "308332",

    "team": "INBOX"

}

Escalate case

To remotely update or escalate cases in iCasework, use the CreateAction API as outlined below. CreateAction is a POST HTTPS request with a JSON/XML/POST parameter payload. Upon a successful call a predefined task will be completed in iCasework triggering the relevant escalation path.

The API request

The endpoint URL for the API is as follows:

UAT: https://uat.icasework.com/createaction?db=<YourId>

Live: https://<YourId>.icasework.com/createaction

Authentication

You can authenticate the request by using OAuth2 based authentication, which is discussed in the iCasework API documentation.

Parameters

Other parameters in the request can be passed as a JSON/XML payload in the request body or as POST parameters in the request. The following are the parameters required for a successful request.

External case update

NameValueDescription
CaseIdiCasework / Resolver case reference numberThe case on which you wish to complete an action or update data.
TypeEXTERNALCASEUPDATEThe Task Code of the action that you wish to complete on the target case.
DetailsTextThe update details for the case.

Stage 1 to Stage 2 escalation

NameValueDescription
CaseIdiCasework / Resolver case reference numberThe case on which you wish to complete an action or update data.
TypeSTAGE1TO2The Task Code of the action that you wish to complete on the target case.
DetailsTextFree text request details


Stage 2 to Stage 3 escalation

NameValueDescription
CaseIdiCasework / Resolver case reference numberThe case on which you wish to complete an action or update data.
TypeSTAGE2TO3The Task Code of the action that you wish to complete on the target case.
DetailsTextFree text request details


Stage 3 to Stage 4 escalation

NameValueDescription
CaseIdiCasework / Resolver case reference numberThe case on which you wish to complete an action or update data.
TypeSTAGE3TO4The Task Code of the action that you wish to complete on the target case.
DetailsTextFree text request details

Example post

https://uat.icasework.com/createaction?db=<your_system_id>&access_token=<access_token>&Format=json

{

"CaseId":"308332",

"Type":"EXTERNALCASEUPDATE",

"Details":"The customer called to request an update on their complaint. A verbal update was provided."

}

Response

Depending on the format selected in the request, a successful response should look like the below, returning the ID of the updated case. In the case of a failed request, the standard HTTPS response codes are used, with the X-Application-Error-Info giving more information about the cause of the error.


XML

<createaction>

    <caseid>308332</caseid>

</createaction>


JSON  

{

    "caseid": "308332",

}

Civica 2020. All Rights Reserved