Get Chat
Overview
This request gets a specified chat interaction.
Request URL | /api/v2/chats/{chatId} |
---|---|
HTTP Method | POST |
Parameters
Parameter Name | Sample Value | Description | Required/Optional |
---|---|---|---|
operationName | "GetChat" | To identify the operation to be performed at this URL | Required |
userId | "007553863DC30029" | User ID | Required |
secureKey | "8b31761b2154884c" | Secure key | Required |
alias | "117" | Host alias | Required |
tenantName | "Environment" | Tenant name | Required |
Example
Request
{ "operationName" : "GetChat", "alias" : "117", "secureKey" : "8b31761b2154884c", "userId" : "007553863DC30029", "tenantName": "Environment" }
Response
{ "statusCode": 0, "state": "Chatting", "alias": "117", "secureKey": "b89d1c2714b01389", "userId": "007553D184850003", "tenantName": "Environment", "participants": [ { "nickname": "nickname", "participantId": 1, "type": "Client" }, { "nickname": "system", "participantId": 2, "type": "External" } ], "chatEnded":false }
This page was last edited on September 17, 2014, at 16:10.
Comments or questions about this documentation? Contact us for support!