Agendize Chat API

Chat Messages


Resource representation

{ "id": {string}, "sessionId": {string}, "message": {string}, "source": {string}, "sent": { "datetime": {string}, "timeZone": {string} }, }
Parameter name Value Description
id string Identifier of the chat message.
sessionId string Chat session identifier.
message string Text of the message.
source string Writer of the message, Values: "operator" or "visitor".
sent object The send date of the message.
sent.dateTime string The time, as a combined date-time value (formatted according to RFC 3339, without time zone information).
sent.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 http://az2.agendize.com/api/2.0/chat/messages/{messageId}

Parameters

Parameter name Value Description
Path parameters
sessionId string Message identifier.

Request body

Do not supply a request body with this method.

Response

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


List

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

Request

HTTP Request

GET http://az2.agendize.com/api/2.0/chat/messages

Parameters

Parameter name Value Description
Optional query parameters
sessionId string Identifier of a chat session.

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: [Message Resource] }

Send

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

Request

HTTP Request

POST http://az2.agendize.com/api/2.0/chat/messages

Request body

In the request body, supply a Message Resource with the following properties:

Parameter name Value Description
Required Properties
name string Name of the queue.

Response

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


Watch

Watch for chat message.

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

Request

HTTP Request

POST http://az2.agendize.com/api/2.0/chat/messages/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.