Edit Customer

Calls ECE’s Edit individual customer API to modify the values of certain attributes associated with an existing individual customer record. You’ll need to pass a valid xEgainSession (that can be generated by using the ECE Login node) for using this node.

The node offers two methods:

  • Edit Individual Customer on SMS that allows you to edit the following contact points and custom attributes:
    • phoneNo and countryCode
    • smsececonversationid
    • smsclusterid
  • Edit Individual Customer on Messenger that allows you to edit the following custom attributes:
    • facebookpsid
    • facebookececonversationid
    • facebookclusterid.

Authorization

Refer to the Node Authorization section for more information.

Methods and Outcomes

Edit Individual Customer on SMS

1289
Input VariablesOutput VariablesNode Outcomes
X-EGAIN-SESSION
A valid ECE session ID generated using the ECE Login node.


CONTACT PERSION ID
Details of the contact person associated with the requested customer

CUSTOMER ID
Unique ID of the Customer (received through Search Customer node).

CLUSTER ID
Attribute used to store the ECE Cluster ID when a customer is in conversation within an agent.


CONVERSATION ID
Attributed used to store the Conversation ID when a customer is in conversation within an agent.


CONTACT POINT ID
ID of the contact point where phone number is stored. This is available in the response variable after a successful Search Customer node execution.


PHONE NUMBER
Phone number of the customer without country code


COUNTRY CODE
* Country code associated with the phone number
NAonInvalidData

Request processing failed due to missing data.

onError

Request processing failed due to an error.

onInvalidChoice

Request processing failed but there is no outcome configured for the concerned scenario.

onTimeout

Request processing timed out.

Bad Request

Any query parameter is sent in the request.
Request body does not contain the required elements.
Unsupported element is present in the request body.
Any criteria for successful execution mentioned in the Request Body section is violated.


Unauthorized

X-egain-session request header is missing.
Session is invalid or expired.


Forbidden

The user does not have sufficient permissions.


Internal server error

Request processing failed because of internal server error.


onCustomerRecordUpdateSuccess

Successfully modified the customer.

Edit Individual Customer on Messenger

1289
Input VariablesOutput VariablesNode Outcomes
X-EGAIN-SESSION
A valid ECE session ID generated using the ECE Login node.



CUSTOMER ID
Unique ID of the Customer (received through Search Customer node).


CLUSTER ID
Attribute used to store the ECE Cluster ID when a customer is in conversation within an agent.



CONVERSATION ID
Attributed used to store the Conversation ID when a customer is in conversation within an agent.


FACEBOOK PSID
Facebook Messenger Page Scoped ID of the customer


CONTACT PERSION ID
Details of the contact person associated with the requested customer
NAonInvalidData

Request processing failed due to missing data.

onError

Request processing failed due to an error.

onInvalidChoice

Request processing failed but there is no outcome configured for the concerned scenario.

onTimeout

Request processing timed out.

Bad Request
Any query parameter is sent in the request.
Request body does not contain the required elements.
Unsupported element is present in the request body.
Any criteria for successful execution mentioned in the Request Body section is violated.


Unauthorized
X-egain-session request header is missing.
Session is invalid or expired.


Forbidden
The user does not have sufficient permissions.


Internal server error
Request processing failed because of internal server error.


onCustomerRecordUpdateSuccess
* Successfully modified the customer

onauthorizationfail

The authorization has failed due to authentication

📘

Utility of ‘Search Customer’ and ‘Edit Customer’ nodes in imiconnect and Cisco Contact Centre Enterprise (CCE) integration

As a pre-requisite for imiconnect and Cisco Contact Centre Enterprise (CCE) integration via ECE, you’re required to add a few attributes for each of SMS and Facebook Messenger channel such as facebookececonversationid and facebookclusterid, etc. When a customer starts a conversation with an agent on Facebook Messenger (and likewise on SMS), these fields are updated using the Edit Customer node to store the values of the conversation ID and the ECE cluster ID against the channel specific customer identifier. Subsequently, whenever an incoming message is received from a customer, this node allows you to check whether the received message is for an existing conversation or is it a new conversation. When a conversation is closed, you can use the Edit Customer node again to clear off the values in facebookececonversationid and facebookclusterid fields.