All Classes Pages
StartConversationExamples Class Reference

More...

Detailed Description

Examples for start conversation

Example 1 - Start conversation with required attributes

This example demonstrates the following:

  • Start conversation with required attributes
  • Start conversation for existing customer
  • Start conversation with "email.emailAddress" as the value for "searchContactOnAttribute" query parameter.

XML

Request

Method URL
POST /ws/v19/clientapplications/messaging/conversation/start?searchContactOnAttribute=email.emailAddress

Request headers

Name Value
Authorization Bearer 082c60a9-6a3c-4880-848c-9af92f074e8d
Accept application/xml
Content-Type application/xml
Accept-Language en-US

Request body 

<?xml version="1.0" encoding="UTF-8"?>
<conversation xmlns="http://bindings.egain.com/ws/model/v19/gen/live/conversation" xmlns:ns6="http://bindings.egain.com/ws/model/v19/gen/interaction/activity" xmlns:ns2="http://bindings.egain.com/ws/model/v19/gen/interaction/customer" xmlns:ns3="http://bindings.egain.com/ws/model/v19/gen/interaction/contactperson" xmlns:ns4="http://bindings.egain.com/ws/model/v19/gen/interaction/contactpoint" xmlns:ns5="http://bindings.egain.com/ws/model/v19/gen/common" xmlns:ns7="http://bindings.egain.com/ws/model/v19/gen/live/entrypoint">
    <entryPointConfiguration>
        <ns7:entryPoint id="1000" />
        <ns7:lastModified date="2019-04-17T10:56:49.000Z" />
    </entryPointConfiguration>
    <activity>
        <ns6:customer>
            <ns2:type>
                <ns2:value>individual</ns2:value>
            </ns2:type>
            <ns2:contacts>
                <ns3:contact>
                      <ns3:firstName>John</ns3:firstName>
                    <ns3:email>
                        <ns4:emailAddress>johntiernay@gmail.com</ns4:emailAddress>
                    </ns3:email>
                </ns3:contact>
            </ns2:contacts>
        </ns6:customer>
    </activity>
</conversation>

Response
HTTP/1.1 200 OK

Response body 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns9:conversation xmlns="http://bindings.egain.com/ws/model/v19/gen/live/entrypoint" xmlns:ns2="http://bindings.egain.com/ws/model/v19/gen/platform" xmlns:ns3="http://bindings.egain.com/ws/model/v19/gen/common" xmlns:ns4="http://bindings.egain.com/ws/model/v19/gen/kb" xmlns:ns5="http://bindings.egain.com/ws/model/v19/gen/kb/edition" xmlns:ns6="http://bindings.egain.com/ws/model/v19/gen/kb/profile" xmlns:ns7="http://bindings.egain.com/ws/model/v19/gen/common/attribute" xmlns:ns8="http://bindings.egain.com/ws/model/v19/gen/platform/security" xmlns:ns9="http://bindings.egain.com/ws/model/v19/gen/live/conversation" xmlns:ns10="http://bindings.egain.com/ws/model/v19/gen/interaction/activity" xmlns:ns11="http://bindings.egain.com/ws/model/v19/gen/interaction/case" xmlns:ns12="http://bindings.egain.com/ws/model/v19/gen/interaction/folder" xmlns:ns13="http://bindings.egain.com/ws/model/v19/gen/interaction/customer" xmlns:ns14="http://bindings.egain.com/ws/model/v19/gen/interaction/contactperson" xmlns:ns15="http://bindings.egain.com/ws/model/v19/gen/interaction/contactpoint" xmlns:ns16="http://bindings.egain.com/ws/model/v19/gen/interaction/attachment" xmlns:ns17="http://bindings.egain.com/ws/model/v19/gen/mail/alias" id="97a5be3b-fbc2-4035-9607-43cc51e20db6">
    <ns9:activity id="1401">
        <ns10:case id="1360" />
    </ns9:activity>
</ns9:conversation>

     

JSON

Request

Method URL
POST /ws/v19/clientapplications/messaging/conversation/start?searchContactOnAttribute=email.emailAddress

Request headers

Name Value
Authorization Bearer 082c60a9-6a3c-4880-848c-9af92f074e8d
Accept application/json
Content-Type application/json
Accept-Language en-US

Request body 

{
  "entryPointConfiguration": {
    "entryPoint": {
      "id": "1000"
    },
    "lastModified": {
      "date": "2019-04-17T10:56:49.000Z"
    }
  },
  "activity": {
    "customer": {
      "type": {
        "value": "individual"
      },
      "contacts": {
        "contact": [
          {
            "firstName": "John",
            "email": [
              {
                "emailAddress": "johntiernay@gmail.com"
              }
            ]
          }
        ]
      }
    }
  }
}

Response
HTTP/1.1 200 OK

Response body 

{
  "activity": {
    "case": {
      "id": 1364
    },
    "id": 1405
  },
  "id": "174bdb0c-7707-4ad0-9a48-56bf07d6e501"
}

     


Example 2 - Start conversation with all attributes

This example demonstrates the following:

  • Start conversation with all attributes
  • Representation showing all supported customer attributes to create a new customer. Note that a new customer will be created only if a customer with provided lookup details does not exist.
  • Start conversation with "office.phone" as the value for "searchContactOnAttribute" query parameter.
  • Start conversation with "mobile.phone" as the value for "conversationContact" query parameter.

XML

Request

Method URL
POST /ws/v19/clientapplications/messaging/conversation/start?searchContactOnAttribute=office.phone&conversationContact=mobile.phone

Request headers

Name Value
Authorization Bearer 082c60a9-6a3c-4880-848c-9af92f074e8d
Accept application/xml
Content-Type application/xml
Accept-Language en-US

Request body 

<?xml version="1.0" encoding="UTF-8"?>
<conversation xmlns="http://bindings.egain.com/ws/model/v19/gen/live/conversation" xmlns:ns6="http://bindings.egain.com/ws/model/v19/gen/interaction/activity" xmlns:ns2="http://bindings.egain.com/ws/model/v19/gen/interaction/customer" xmlns:ns3="http://bindings.egain.com/ws/model/v19/gen/interaction/contactperson" xmlns:ns4="http://bindings.egain.com/ws/model/v19/gen/interaction/contactpoint" xmlns:ns5="http://bindings.egain.com/ws/model/v19/gen/common" xmlns:ns7="http://bindings.egain.com/ws/model/v19/gen/live/entrypoint">
    <entryPointConfiguration>
        <ns7:entryPoint id="1000" />
        <ns7:lastModified date="2019-01-03T12:27:25.000Z" />
    </entryPointConfiguration>
    <activity>
        <ns6:subject>Bill Related</ns6:subject>
        <ns6:payload>
            <ns6:chat>
                <ns6:clientInfo>
                    <ns6:timeOffset>-180</ns6:timeOffset>
                    <ns6:referrerName>google</ns6:referrerName>
                    <ns6:referrerUrl>https://www.google.com</ns6:referrerUrl>
                    <ns6:isRichTextSupported>true</ns6:isRichTextSupported>
                </ns6:clientInfo>
            </ns6:chat>
        </ns6:payload>
        <ns6:customer>
            <ns2:type>
                <ns2:value>individual</ns2:value>
            </ns2:type>
            <ns2:contacts>
                <ns3:contact>
                    <ns3:externalId>C987666</ns3:externalId>
                    <ns3:firstName>John</ns3:firstName>
                    <ns3:lastName>Tierney</ns3:lastName>
                    <ns3:phone>
                        <ns4:type>
                            <ns5:value>home</ns5:value>
                        </ns4:type>
                        <ns4:phoneNo>7785451199</ns4:phoneNo>
                        <ns4:countryCode>44</ns4:countryCode>
                        <ns4:areaCode>01</ns4:areaCode>
                        <ns4:extension>25</ns4:extension>
                    </ns3:phone>
                    <ns3:phone>
                        <ns4:type>
                            <ns5:value>mobile</ns5:value>
                        </ns4:type>
                        <ns4:phoneNo>5568879899</ns4:phoneNo>
                        <ns4:countryCode>44</ns4:countryCode>
                    </ns3:phone>
                    <ns3:phone>
                        <ns4:type>
                            <ns5:value>office</ns5:value>
                        </ns4:type>
                        <ns4:phoneNo>988564334</ns4:phoneNo>
                        <ns4:countryCode>44</ns4:countryCode>
                        <ns4:areaCode>01</ns4:areaCode>
                        <ns4:extension>25</ns4:extension>
                    </ns3:phone>
                    <ns3:email>
                        <ns4:emailAddress>johntiernay@gmail.com</ns4:emailAddress>
                    </ns3:email>
                    <ns3:customAttributes>
                        <ns5:customAttribute>
                            <ns5:attribName>preferredcontact</ns5:attribName>
                            <ns5:attribValues>
                                <ns5:attribValue>
                                    <ns5:value>email</ns5:value>
                                </ns5:attribValue>
                            </ns5:attribValues>
                        </ns5:customAttribute>
                    </ns3:customAttributes>
                </ns3:contact>
            </ns2:contacts>
        </ns6:customer>
        <ns6:customAttributes>
            <ns5:customAttribute>
                <ns5:attribName>identification_no</ns5:attribName>
                <ns5:attribValues>
                    <ns5:attribValue>
                        <ns5:value>2873354764</ns5:value>
                    </ns5:attribValue>
                </ns5:attribValues>
            </ns5:customAttribute>
        </ns6:customAttributes>
    </activity>
</conversation>

Response
HTTP/1.1 200 OK

Response body 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns9:conversation xmlns="http://bindings.egain.com/ws/model/v19/gen/live/entrypoint" xmlns:ns2="http://bindings.egain.com/ws/model/v19/gen/platform" xmlns:ns3="http://bindings.egain.com/ws/model/v19/gen/common" xmlns:ns4="http://bindings.egain.com/ws/model/v19/gen/kb" xmlns:ns5="http://bindings.egain.com/ws/model/v19/gen/kb/edition" xmlns:ns6="http://bindings.egain.com/ws/model/v19/gen/kb/profile" xmlns:ns7="http://bindings.egain.com/ws/model/v19/gen/common/attribute" xmlns:ns8="http://bindings.egain.com/ws/model/v19/gen/platform/security" xmlns:ns9="http://bindings.egain.com/ws/model/v19/gen/live/conversation" xmlns:ns10="http://bindings.egain.com/ws/model/v19/gen/interaction/activity" xmlns:ns11="http://bindings.egain.com/ws/model/v19/gen/interaction/case" xmlns:ns12="http://bindings.egain.com/ws/model/v19/gen/interaction/folder" xmlns:ns13="http://bindings.egain.com/ws/model/v19/gen/interaction/customer" xmlns:ns14="http://bindings.egain.com/ws/model/v19/gen/interaction/contactperson" xmlns:ns15="http://bindings.egain.com/ws/model/v19/gen/interaction/contactpoint" xmlns:ns16="http://bindings.egain.com/ws/model/v19/gen/interaction/attachment" xmlns:ns17="http://bindings.egain.com/ws/model/v19/gen/mail/alias" id="97a5be3b-fbc2-4035-9607-43cc51e20db6">
    <ns9:activity id="1401">
        <ns10:case id="1360" />
    </ns9:activity>
</ns9:conversation>

     

JSON

Request

Method URL
POST /ws/v19/clientapplications/messaging/conversation/start?searchContactOnAttribute=office.phone&conversationContact=mobile.phone

Request headers

Name Value
Authorization Bearer 082c60a9-6a3c-4880-848c-9af92f074e8d
Accept application/json
Content-Type application/json
Accept-Language en-US

Request body 

{
  "entryPointConfiguration": {
    "entryPoint": {
      "id": "1000"
    },
    "lastModified": {
      "date": "2019-04-17T10:56:49.000Z"
    }
  },
  "activity": {
    "subject": "Bill Related",
    "payload": {
      "chat": {
        "clientInfo": {
          "timeOffset": "+180",
          "referrerName": "google",
          "referrerUrl": "https://www.google.com",
          "isRichTextSupported":"true"
        }
      }
    },
    "customer": {
      "type": {
        "value": "individual"
      },
      "contacts": {
        "contact": [
          {
            "externalId": "C987666",
            "firstName": "John",
            "lastName": "Tierney",
            "phone": [
              {
                "type": {
                  "value": "home"
                },
                "phoneNo": "7785451199",
                "countryCode": "44",
                "areaCode": "01",
                "extension": "25"
              },
              {
                "type": {
                  "value": "mobile"
                },
                "phoneNo": "4567889644",
                "countryCode": "44"
              },
			  {
                "type": {
                  "value": "office"
                },
                "phoneNo": "6678895451",
                "countryCode": "44",
                "areaCode": "01",
                "extension": "25"
              }
            ],
            "email": [
              {
                "emailAddress": "johntiernay@gmail.com"
              }
            ],
            "customAttributes": {
              "customAttribute": [
                {
                  "attribName": "preferredcontact",
                  "attribValues": {
                    "attribValue": [
                      {
                        "value": "phone"
                      }
                    ]
                  }
                }
              ]
            }
          }
        ]
      }
    },
    "customAttributes": {
      "customAttribute": [
        {
          "attribName": "identification_no",
          "attribValues": {
            "attribValue": [
              {
                "value": "287335476"
              }
            ]
          }
        }
      ]
    }
  }
}

Response
HTTP/1.1 200 OK

Response body 

{
  "activity": {
    "case": {
      "id": 1364
    },
    "id": 1405
  },
  "id": "174bdb0c-7707-4ad0-9a48-56bf07d6e501"
}

     


Example 3 - Start conversation with all default attributes

This example demonstrates the following:

  • Start conversation with all default attributes.
  • Representation showing all supported default attributes to existing customer of case mentioned in case.id.
  • Start conversation with "email.emailAddres" as the value for "searchContactOnAttribute" query parameter.
  • Start conversation with "mobile.phone" as the value for "conversationContact" query parameter.
  • Start conversation with "yes" as the value for "sendTypingNotification" query parameter.

XML

Request

Method URL
POST /ws/v19/clientapplications/messaging/conversation/start?sendTypingNotification=yes&searchContactOnAttribute=email.emailAddress&conversationContact=mobile.phone

Request headers

Name Value
Authorization Bearer 082c60a9-6a3c-4880-848c-9af92f074e8d
Accept application/xml
Content-Type application/xml
Accept-Language en-US

Request body 

<?xml version="1.0" encoding="UTF-8"?>
<conversation xmlns="http://bindings.egain.com/ws/model/v19/gen/live/conversation" xmlns:ns6="http://bindings.egain.com/ws/model/v19/gen/interaction/activity" xmlns:ns2="http://bindings.egain.com/ws/model/v19/gen/interaction/customer" xmlns:ns3="http://bindings.egain.com/ws/model/v19/gen/interaction/contactperson" xmlns:ns4="http://bindings.egain.com/ws/model/v19/gen/interaction/contactpoint" xmlns:ns5="http://bindings.egain.com/ws/model/v19/gen/common" xmlns:ns7="http://bindings.egain.com/ws/model/v19/gen/live/entrypoint">
    <entryPointConfiguration>
        <ns7:entryPoint id="1000" />
        <ns7:lastModified date="2019-04-17T10:56:49.000Z" />
    </entryPointConfiguration>
    <activity>
        <ns6:subject>Bill Related</ns6:subject>
        <ns6:case id="1021" />
        <ns6:payload>
            <ns6:chat>
                <ns6:clientInfo>
                    <ns6:timeOffset>-180</ns6:timeOffset>
                    <ns6:referrerName>google</ns6:referrerName>
                    <ns6:referrerUrl>https://www.google.com</ns6:referrerUrl>
                      <ns6:isRichTextSupported >true</ns6:isRichTextSupported >
                </ns6:clientInfo>
            </ns6:chat>
        </ns6:payload>
        <ns6:customer>
            <ns2:type>
                <ns2:value>individual</ns2:value>
            </ns2:type>
            <ns2:contacts>
                <ns3:contact>
                    <ns3:externalId>C987666</ns3:externalId>
                    <ns3:firstName>John</ns3:firstName>
                    <ns3:lastName>Tierney</ns3:lastName>
                    <ns3:phone>
                        <ns4:type>
                            <ns5:value>home</ns5:value>
                        </ns4:type>
                        <ns4:phoneNo>7785451199</ns4:phoneNo>
                        <ns4:countryCode>44</ns4:countryCode>
                        <ns4:areaCode>01</ns4:areaCode>
                        <ns4:extension>25</ns4:extension>
                    </ns3:phone>
                    <ns3:phone>
                        <ns4:type>
                            <ns5:value>mobile</ns5:value>
                        </ns4:type>
                        <ns4:phoneNo>5568879899</ns4:phoneNo>
                        <ns4:countryCode>44</ns4:countryCode>
                    </ns3:phone>
                    <ns3:phone>
                        <ns4:type>
                            <ns5:value>office</ns5:value>
                        </ns4:type>
                        <ns4:phoneNo>988564334</ns4:phoneNo>
                        <ns4:countryCode>44</ns4:countryCode>
                        <ns4:areaCode>01</ns4:areaCode>
                        <ns4:extension>25</ns4:extension>
                    </ns3:phone>
                    <ns3:email>
                        <ns4:emailAddress>johntiernay@gmail.com</ns4:emailAddress>
                    </ns3:email>
                </ns3:contact>
            </ns2:contacts>
        </ns6:customer>
    </activity>
</conversation>

Response
HTTP/1.1 200 OK

Response body 

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<ns9:conversation xmlns="http://bindings.egain.com/ws/model/v19/gen/live/entrypoint" xmlns:ns2="http://bindings.egain.com/ws/model/v19/gen/platform" xmlns:ns3="http://bindings.egain.com/ws/model/v19/gen/common" xmlns:ns4="http://bindings.egain.com/ws/model/v19/gen/kb" xmlns:ns5="http://bindings.egain.com/ws/model/v19/gen/kb/edition" xmlns:ns6="http://bindings.egain.com/ws/model/v19/gen/kb/profile" xmlns:ns7="http://bindings.egain.com/ws/model/v19/gen/common/attribute" xmlns:ns8="http://bindings.egain.com/ws/model/v19/gen/platform/security" xmlns:ns9="http://bindings.egain.com/ws/model/v19/gen/live/conversation" xmlns:ns10="http://bindings.egain.com/ws/model/v19/gen/interaction/activity" xmlns:ns11="http://bindings.egain.com/ws/model/v19/gen/interaction/case" xmlns:ns12="http://bindings.egain.com/ws/model/v19/gen/interaction/folder" xmlns:ns13="http://bindings.egain.com/ws/model/v19/gen/interaction/customer" xmlns:ns14="http://bindings.egain.com/ws/model/v19/gen/interaction/contactperson" xmlns:ns15="http://bindings.egain.com/ws/model/v19/gen/interaction/contactpoint" xmlns:ns16="http://bindings.egain.com/ws/model/v19/gen/interaction/attachment" xmlns:ns17="http://bindings.egain.com/ws/model/v19/gen/mail/alias" id="20831f9c-5b9a-4411-8c57-89cfa051d38d">
    <ns9:activity id="1037">
        <ns10:case id="1021"/>
    </ns9:activity>
</ns9:conversation>

     

JSON

Request

Method URL
POST /ws/v19/clientapplications/messaging/conversation/start?sendTypingNotification=yes&searchContactOnAttribute=email.emailAddress&conversationContact=mobile.phone

Request headers

Name Value
Authorization Bearer 082c60a9-6a3c-4880-848c-9af92f074e8d
Accept application/json
Content-Type application/json
Accept-Language en-US

Request body 

{
  "entryPointConfiguration": {
    "entryPoint": {
      "id": "1000"
    },
    "lastModified": {
      "date": "2019-04-17T10:56:49.000Z"
    }
  },
  "activity": {
    "subject": "Bill Related",
    "case": {
      "id": "1021"
    },
    "payload": {
      "chat": {
        "clientInfo": {
          "timeOffset": "+180",
          "referrerName": "google",
          "referrerUrl": "https://www.google.com",
          "isRichTextSupported":"true"
        }
      }
    },
    "customer": {
      "type": {
        "value": "individual"
      },
      "contacts": {
        "contact": [
          {
            "externalId": "C987666",
            "firstName": "John",
            "lastName": "Tierney",
            "phone": [
              {
                "type": {
                  "value": "home"
                },
                "phoneNo": "7785451199",
                "countryCode": "44",
                "areaCode": "01",
                "extension": "25"
              },
              {
                "type": {
                  "value": "mobile"
                },
                "phoneNo": "4567889644",
                "countryCode": "44"
              },
              {
                "type": {
                  "value": "office"
                },
                "phoneNo": "6678895451",
                "countryCode": "44",
                "areaCode": "01",
                "extension": "25"
              }
            ],
            "email": [
              {
                "emailAddress": "johntiernay@gmail.com"
              }
            ]
          }
        ]
      }
    }
  }
}

Response
HTTP/1.1 200 OK

Response body 

{
    "activity": {
        "case": {
            "id": 1021
        },
        "id": 1038
    },
    "id": "f5419d71-9d49-444d-850c-aa7920e571e0"
}

     


Example 4 - Start conversation with required attributes for anonymous customer

This example demonstrates the following:

  • Start conversation with required attributes
  • Start conversation for an anonymous customer

XML

Request

Method URL
POST /ws/v19/clientapplications/messaging/conversation/start?anonymousCustomer=yes

Request headers

Name Value
Authorization Bearer 082c60a9-6a3c-4880-848c-9af92f074e8d
Accept application/xml
Content-Type application/xml
Accept-Language en-US

Request body 

<?xml version="1.0" encoding="UTF-8"?>
<conversation xmlns="http://bindings.egain.com/ws/model/v19/gen/live/conversation" xmlns:ns6="http://bindings.egain.com/ws/model/v19/gen/interaction/activity" xmlns:ns2="http://bindings.egain.com/ws/model/v19/gen/interaction/customer" xmlns:ns3="http://bindings.egain.com/ws/model/v19/gen/interaction/contactperson" xmlns:ns4="http://bindings.egain.com/ws/model/v19/gen/interaction/contactpoint" xmlns:ns5="http://bindings.egain.com/ws/model/v19/gen/common" xmlns:ns7="http://bindings.egain.com/ws/model/v19/gen/live/entrypoint">
    <entryPointConfiguration>
        <ns7:entryPoint id="1000" />
        <ns7:lastModified date="2019-01-03T12:27:25.000Z" />
    </entryPointConfiguration>
</conversation>

Response
HTTP/1.1 200 OK

Response body 

<?xml version="1.0" encoding="UTF-8"?>
<ns9:conversation xmlns:ns9="http://bindings.egain.com/ws/model/v19/gen/live/conversation" xmlns="http://bindings.egain.com/ws/model/v19/gen/live/entrypoint" xmlns:ns10="http://bindings.egain.com/ws/model/v19/gen/interaction/activity" xmlns:ns11="http://bindings.egain.com/ws/model/v19/gen/interaction/case" xmlns:ns12="http://bindings.egain.com/ws/model/v19/gen/interaction/folder" xmlns:ns13="http://bindings.egain.com/ws/model/v19/gen/interaction/customer" xmlns:ns14="http://bindings.egain.com/ws/model/v19/gen/interaction/contactperson" xmlns:ns15="http://bindings.egain.com/ws/model/v19/gen/interaction/contactpoint" xmlns:ns16="http://bindings.egain.com/ws/model/v19/gen/interaction/attachment" xmlns:ns17="http://bindings.egain.com/ws/model/v19/gen/mail/alias" xmlns:ns2="http://bindings.egain.com/ws/model/v19/gen/platform" xmlns:ns3="http://bindings.egain.com/ws/model/v19/gen/common" xmlns:ns4="http://bindings.egain.com/ws/model/v19/gen/kb" xmlns:ns5="http://bindings.egain.com/ws/model/v19/gen/kb/edition" xmlns:ns6="http://bindings.egain.com/ws/model/v19/gen/kb/profile" xmlns:ns7="http://bindings.egain.com/ws/model/v19/gen/common/attribute" xmlns:ns8="http://bindings.egain.com/ws/model/v19/gen/platform/security" id="97a5be3b-fbc2-4035-9607-43cc51e20db6">
   <ns9:activity id="1401">
      <ns10:case id="1360" />
   </ns9:activity>
</ns9:conversation>

     

JSON

Request

Method URL
POST /ws/v19/clientapplications/messaging/conversation/start?anonymousCustomer=yes

Request headers

Name Value
Authorization Bearer 082c60a9-6a3c-4880-848c-9af92f074e8d
Accept application/json
Content-Type application/json
Accept-Language en-US

Request body 

{
  "entryPointConfiguration": {
    "entryPoint": {
      "id": "1000"
    },
    "lastModified": {
      "date": "2019-01-03T12:27:25.000Z"
    }
  }
}

Response
HTTP/1.1 200 OK

Response body 

{
  "activity": {
    "case": {
      "id": 1364
    },
    "id": 1405
  },
  "id": "174bdb0c-7707-4ad0-9a48-56bf07d6e501"
}

     


Example 5 - Start conversation with all attributes for anonymous customer

This example demonstrates the following:

  • Start conversation for an anonymous customer with all supported attributes. Note that customer representation is not in the request payload since the conversation is for an anonymous customer.

XML

Request

Method URL
POST /ws/v19/clientapplications/messaging/conversation/start?anonymousCustomer=yes

Request headers

Name Value
Authorization Bearer 082c60a9-6a3c-4880-848c-9af92f074e8d
Accept application/xml
Content-Type application/xml
Accept-Language en-US

Request body 

<?xml version="1.0" encoding="UTF-8"?>
<conversation xmlns="http://bindings.egain.com/ws/model/v19/gen/live/conversation" xmlns:ns2="http://bindings.egain.com/ws/model/v19/gen/interaction/customer" xmlns:ns3="http://bindings.egain.com/ws/model/v19/gen/interaction/contactperson" xmlns:ns4="http://bindings.egain.com/ws/model/v19/gen/interaction/contactpoint" xmlns:ns5="http://bindings.egain.com/ws/model/v19/gen/common" xmlns:ns6="http://bindings.egain.com/ws/model/v19/gen/interaction/activity" xmlns:ns7="http://bindings.egain.com/ws/model/v19/gen/live/entrypoint">
   <entryPointConfiguration>
      <ns7:entryPoint id="1000" />
      <ns7:lastModified date="2019-01-03T12:27:25.000Z" />
   </entryPointConfiguration>
   <activity>
      <ns6:subject>Bill Related</ns6:subject>
      <ns6:payload>
         <ns6:chat>
            <ns6:clientInfo>
               <ns6:timeOffset>+150</ns6:timeOffset>
               <ns6:referrerName>google</ns6:referrerName>
               <ns6:referrerUrl>https://www.google.com</ns6:referrerUrl>
               <ns6:isRichTextSupported>true</ns6:isRichTextSupported>
            </ns6:clientInfo>
         </ns6:chat>
      </ns6:payload>
      <ns6:customAttributes>
         <ns5:customAttribute>
            <ns5:attribName>identification_no</ns5:attribName>
            <ns5:attribValues>
               <ns5:attribValue>
                  <ns5:value>287335476</ns5:value>
               </ns5:attribValue>
            </ns5:attribValues>
         </ns5:customAttribute>
      </ns6:customAttributes>
   </activity>
</conversation>

Response
HTTP/1.1 200 OK

Response body 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns9:conversation xmlns="http://bindings.egain.com/ws/model/v19/gen/live/entrypoint" xmlns:ns2="http://bindings.egain.com/ws/model/v19/gen/platform" xmlns:ns3="http://bindings.egain.com/ws/model/v19/gen/common" xmlns:ns4="http://bindings.egain.com/ws/model/v19/gen/kb" xmlns:ns5="http://bindings.egain.com/ws/model/v19/gen/kb/edition" xmlns:ns6="http://bindings.egain.com/ws/model/v19/gen/kb/profile" xmlns:ns7="http://bindings.egain.com/ws/model/v19/gen/common/attribute" xmlns:ns8="http://bindings.egain.com/ws/model/v19/gen/platform/security" xmlns:ns9="http://bindings.egain.com/ws/model/v19/gen/live/conversation" xmlns:ns10="http://bindings.egain.com/ws/model/v19/gen/interaction/activity" xmlns:ns11="http://bindings.egain.com/ws/model/v19/gen/interaction/case" xmlns:ns12="http://bindings.egain.com/ws/model/v19/gen/interaction/folder" xmlns:ns13="http://bindings.egain.com/ws/model/v19/gen/interaction/customer" xmlns:ns14="http://bindings.egain.com/ws/model/v19/gen/interaction/contactperson" xmlns:ns15="http://bindings.egain.com/ws/model/v19/gen/interaction/contactpoint" xmlns:ns16="http://bindings.egain.com/ws/model/v19/gen/interaction/attachment" xmlns:ns17="http://bindings.egain.com/ws/model/v19/gen/mail/alias" id="97a5be3b-fbc2-4035-9607-43cc51e20db6">
    <ns9:activity id="1401">
        <ns10:case id="1360" />
    </ns9:activity>
</ns9:conversation>

     

JSON

Request

Method URL
POST /ws/v19/clientapplications/messaging/conversation/start?anonymousCustomer=yes

Request headers

Name Value
Authorization Bearer 082c60a9-6a3c-4880-848c-9af92f074e8d
Accept application/json
Content-Type application/json
Accept-Language en-US

Request body 

{ 
   "entryPointConfiguration":{ 
      "entryPoint":{ 
         "id":"1000"
      },
      "lastModified":{ 
         "date":"2019-01-03T12:27:25.000Z"
      }
   },
   "activity":{ 
      "subject":"Bill Related",
      "payload":{ 
         "chat":{ 
            "clientInfo":{ 
               "timeOffset":"+50",
               "referrerName":"google",
               "referrerUrl":"https://www.google.com",
               "isRichTextSupported":"true"
            }
         }
      },
      "customAttributes":{ 
         "customAttribute":[ 
            { 
               "attribName":"identification_no",
               "attribValues":{ 
                  "attribValue":[ 
                     { 
                        "value":"287335476"
                     }
                  ]
               }
            }
         ]
      }
   }
}

Response
HTTP/1.1 200 OK

Response body 

{
  "activity": {
    "case": {
      "id": 1364
    },
    "id": 1405
  },
  "id": "174bdb0c-7707-4ad0-9a48-56bf07d6e501"
}

     


Example 6 - Start conversation with default attributes for anonymous customer

This example demonstrates the following:

  • Start Conversation with all default attributes provided in request body for anonymous customer. Note that customer representation is not in the request payload since the conversation is for an anonymous customer.

XML

Request

Method URL
POST /ws/v19/clientapplications/messaging/conversation/start?anonymousCustomer=yes

Request headers

Name Value
Authorization Bearer 082c60a9-6a3c-4880-848c-9af92f074e8d
Accept application/xml
Content-Type application/xml
Accept-Language en-US

Request body 

<?xml version="1.0" encoding="UTF-8"?>
<conversation xmlns="http://bindings.egain.com/ws/model/v19/gen/live/conversation" xmlns:ns6="http://bindings.egain.com/ws/model/v19/gen/interaction/activity" xmlns:ns2="http://bindings.egain.com/ws/model/v19/gen/interaction/customer" xmlns:ns3="http://bindings.egain.com/ws/model/v19/gen/interaction/contactperson" xmlns:ns4="http://bindings.egain.com/ws/model/v19/gen/interaction/contactpoint" xmlns:ns5="http://bindings.egain.com/ws/model/v19/gen/common" xmlns:ns7="http://bindings.egain.com/ws/model/v19/gen/live/entrypoint">
    <entryPointConfiguration>
        <ns7:entryPoint id="1000" />
        <ns7:lastModified date="2019-02-25T15:22:47.000Z" />
    </entryPointConfiguration>
    <activity>
        <ns6:payload>
            <ns6:chat>
                <ns6:clientInfo>
                    <ns6:timeOffset>+150</ns6:timeOffset>
                    <ns6:referrerName>google</ns6:referrerName>
                    <ns6:referrerUrl>https://www.google.com</ns6:referrerUrl>
                </ns6:clientInfo>
            </ns6:chat>
        </ns6:payload>
    </activity>
</conversation>

Response
HTTP/1.1 200 OK

Response body 

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<ns9:conversation xmlns="http://bindings.egain.com/ws/model/v19/gen/live/entrypoint" xmlns:ns2="http://bindings.egain.com/ws/model/v19/gen/platform" xmlns:ns3="http://bindings.egain.com/ws/model/v19/gen/common" xmlns:ns4="http://bindings.egain.com/ws/model/v19/gen/kb" xmlns:ns5="http://bindings.egain.com/ws/model/v19/gen/kb/edition" xmlns:ns6="http://bindings.egain.com/ws/model/v19/gen/kb/profile" xmlns:ns7="http://bindings.egain.com/ws/model/v19/gen/common/attribute" xmlns:ns8="http://bindings.egain.com/ws/model/v19/gen/platform/security" xmlns:ns9="http://bindings.egain.com/ws/model/v19/gen/live/conversation" xmlns:ns10="http://bindings.egain.com/ws/model/v19/gen/interaction/activity" xmlns:ns11="http://bindings.egain.com/ws/model/v19/gen/interaction/case" xmlns:ns12="http://bindings.egain.com/ws/model/v19/gen/interaction/folder" xmlns:ns13="http://bindings.egain.com/ws/model/v19/gen/interaction/customer" xmlns:ns14="http://bindings.egain.com/ws/model/v19/gen/interaction/contactperson" xmlns:ns15="http://bindings.egain.com/ws/model/v19/gen/interaction/contactpoint" xmlns:ns16="http://bindings.egain.com/ws/model/v19/gen/interaction/attachment" xmlns:ns17="http://bindings.egain.com/ws/model/v19/gen/mail/alias" id="9bb16ec0-0da6-44d4-b3b7-aea241ff6e46">
    <ns9:activity id="1034">
        <ns10:case id="1022"/>
    </ns9:activity>
</ns9:conversation>

     

JSON

Request

Method URL
POST /ws/v19/clientapplications/messaging/conversation/start?anonymousCustomer=yes

Request headers

Name Value
Authorization Bearer 082c60a9-6a3c-4880-848c-9af92f074e8d
Accept application/json
Content-Type application/json
Accept-Language en-US

Request body 

{
  "entryPointConfiguration": {
    "entryPoint": {
      "id": "1000"
    },
    "lastModified": {
      "date": "2019-02-25T15:22:47.000Z"
    }
  },
  "activity": {
    "subject": "Bill Related",
    "payload": {
      "chat": {
        "clientInfo": {
          "timeOffset": "+50",
          "referrerName": "google",
          "referrerUrl": "https://www.google.com"
        }
      }
    }
  }
}

Response
HTTP/1.1 200 OK

Response body