Request Chat

Overview

This operation is used to request a chat interaction.

Request URL	/api/v2/chats
HTTP Method	POST
HTTP Header	Content-Type
Value	application/json

Parameters

Parameter Name	Sample Value	Description	Required/Optional
nickname	"JohnDoe"	customer's nickname	Required
firstName	"John"	first name of the customer	Required
lastName	"Doe"	last name of the customer	Required
tenantName	"Environment"	tenant name	Required
emailAddress	"jdoe@gmail.com"	email address of the customer	Optional
subject	"Help with account"	subject as entered by the customer	Optional
endpoint	"customEndpoint"	endpoint describing the queue	Optional
userData	["key":"value","key":"value"]	any attached data that client wants to add to chat	Optional

Example

Request

{
    "tenantName": "Environment",
    "nickname":"nickname",
    "emailAddress":"email@address",
    "subject":"subject to",
    "userData":{
        "key1":"value1",
        "key2":"value2"
    }
}

Response

{
    "chatId":"00019a9SXTQW001N",
    "path":"/api/v2/chats/00019a9SXTQW001N",
    "userId":"007553ADB4D9001A",
    "secureKey":"e1a17b94f802c330",
    "alias":"117",
     "tenantName": "Environment",
    "messages":[
        {
            "from":{
                "nickname":"nickname",
                "participantId":1,
                "type":"Client"
            },
            "index":1,
            "type":"ParticipantJoined",
            "utcTime":1404162425010
        }
    ],
    "statusCode":0
}