Agendize Chat API

Chat Sessions


Resource representation

{ "id": {string}, "button": { "id": {string}, "name": {string} }, "visitor": { "name": {string}, "emailAddress": {string}, "networkAddress": {string}, "startPage": {string}, "country": {string}, "city": {string}, "operatingSystem": {string}, "browser": {string}, "userAgent: {string}, }, "start": { "dateTime": {string}, "timeZone": {string} } }
Parameter name Value Description
id string Identifier of the chat session.
button object Chat button.
button.id string Id of the button.
button.name string Name of the button.
visitor string Visitor.
visitor.name string Name of the Visitor.
visitor.emaillAddress string Email address of the Visitor.
visitor.networkAddress string IP address of the visitor.
visitor.startPage string Web page start page.
visitor.country string Country of the visitor. Based on IP address of the visitor.
visitor.city string City of the visitor. Based on IP address of the visitor.
visitor.operatingSystem string Operating system used by the visitor.
visitor.browser string Type of browser used by the visitor.
visitor.userAgent string User agent string of browser used by the visitor.
start object The start time of the first chat message for this session.
start.dateTime string The time, as a combined date-time value (formatted according to RFC 3339, without time zone information).
start.timeZone string The time zone. Possible values can be found here. The default value is the time zone of the company.

Get

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

GET https://api.agendize.com/api/2.0/chat/sessions/{sessionId}

Parameters

Parameter name Value Description
Path parameters
sessionId string Session identifier.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a Queue resource in the response body.


List

Returns all chat sessions currently active (that have not been closed either by the operator or the user).

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

GET https://api.agendize.com/api/2.0/chat/sessions

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response body with the following structure:

{ items: [Sessions Resource] }

Watch

Watch for chat session.

Authentication is required to execute this request. Please refer to Authentication for more.

The watch send an Session resource in the request body

Request

HTTP Request

POST https://api.agendize.com/api/2.0/chat/sessions/watch

Parameters

Request body

{ "id": {string}, "address": {string} }
Parameter name Value Description
id string Identifier of the watch. Read-only.
address string The address where notifications are delivered for this watch.

Response

If successful, this method returns an of Watch resource in the response body.