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 https://api.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 https://api.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 https://api.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.

The watch send an Message resource in the request body

Request

HTTP Request

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

Request body

{ "address": {string}, "basicAuth": { "username": {string}, "password": {string} }, "httpRequestHeader": { (name): {string} } }
Required Properties
address string The address where notifications are delivered for this watch.
Optional Properties
basicAuth string Credentials parameters for HTTP Basic authentication on the destination watch address. Only if you use this authentication method.
basicAuth.username string Username.
basicAuth.password string Password.
httpRequestHeader string Custom header parameters to send with the http request on the destination watch address.
httpRequestHeader.name string header parameter name.

Response

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