getCurrentAccountSecret operation
{- "$_type": "AccountSecret",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "secretKey": "string"
}
With this service the accounts of the unblu system can be managed. Most of the provided interface needs super admin permissions. Especially if the edited account is not the one of the current user.
The Account object can be expanded. If the query parameter expand is set to contactAddressId and/or billingAddressId (e.g ?expand=contactAddressId,billingAddressId) the address id's will be automatically resolved and wrapped into the object. This can also be done when sending the object
Creates the given entity in the system. The id of the entity can not be set for create operation, a new one is generated.
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
The entity to create
$_type | string Default: "Account" Value: "Account" |
id | string Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway. |
creationTimestamp | integer <int64> Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
modificationTimestamp | integer <int64> Timestamp of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
version | integer <int64> Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted. |
name | string The name of the account. Maximum length of 250 characters and can not be empty. |
string or Address (object) expand-query-key: billingAddress type: ExpandableField The id to an address which is used for billing, if the contact address should not be used. Should be null, if only contact address should be used. | |
string or Address (object) expand-query-key: contactAddress type: ExpandableField The id of the contact address for the account. Is also used for billing if no extra billing address is defined. | |
string or Avatar (object) expand-query-key: avatar type: ExpandableField Avatar of the entity: id that can be expanded. | |
object expand-query-key: configuration type: Map The entity's configuration properties. Only contains values when the 'expand' query parameter is used with the value 'configuration'. | |
object expand-query-key: metadata type: Map The entity's metadata properties. Only contains values when the 'expand' query parameter is used with the value 'metadata'. | |
object expand-query-key: text type: Map The entity's text properties. Only contains values when the 'expand' query parameter is used with the value 'text'. |
{- "$_type": "Account",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "name": "string",
- "billingAddress": "string",
- "contactAddress": "string",
- "avatar": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}
}
{- "$_type": "Account",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "name": "string",
- "billingAddress": "string",
- "contactAddress": "string",
- "avatar": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}
}
createAccountWithNewAdmin operation
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
$_type | string Default: "AccountUserContainer" Value: "AccountUserContainer" |
object (Account) Model of an account. The contact and the billing address can be directly resolved when using the expand feature. | |
object (User) Model of a user. A user is normally an agent and/or a person who manages the system |
Create an Account and an Admin user for it
{- "$_type": "AccountUserContainer",
- "account": {
- "$_type": "Account",
- "id": null,
- "creationTimestamp": null,
- "modificationTimestamp": null,
- "version": null,
- "name": "with-admin-test",
- "billingAddress": null,
- "contactAddress": null,
- "avatar": null,
- "configuration": null,
- "metadata": null,
- "text": null
}, - "adminUser": {
- "$_type": "User",
- "id": null,
- "creationTimestamp": null,
- "modificationTimestamp": null,
- "version": null,
- "accountId": null,
- "avatar": null,
- "username": "test@email.com",
- "email": "test@email.com",
- "phone": null,
- "teamId": null,
- "authorizationRole": "ADMIN",
- "displayName": "J. Doe",
- "firstName": "John",
- "lastName": "Doe",
- "externallyManaged": null,
- "virtualUser": null,
- "configuration": null,
- "metadata": null
}
}
{- "$_type": "AccountUserContainer",
- "account": {
- "$_type": "Account",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "name": "string",
- "billingAddress": "string",
- "contactAddress": "string",
- "avatar": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}
}, - "adminUser": {
- "$_type": "User",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "avatar": "string",
- "username": "string",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "authorizationRole": "SUPER_ADMIN",
- "displayName": "string",
- "firstName": "string",
- "lastName": "string",
- "externallyManaged": true,
- "virtualUser": true,
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
}
Deletes the entity for the given id
id | string The id of the entity which should be deleted |
{- "$_type": "Error",
- "statusCode": 0,
- "statusDescription": "string",
- "errorMessage": "string"
}
Returns an account by the given name or null, if there is no such account
name | string The name of the account which should be returned |
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
{- "$_type": "Account",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "name": "string",
- "billingAddress": "string",
- "contactAddress": "string",
- "avatar": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}
}
Returns the account object of the current logged in user
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
{- "$_type": "Account",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "name": "string",
- "billingAddress": "string",
- "contactAddress": "string",
- "avatar": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}
}
Checks if the account name is available for the given account id
name | string The name which should be checked |
accountId | string The account id of the user for who the account should be set. When changing the name of an existing account, its id should be given. When the name is set to the one of the account, it will then also return true. |
true
Returns the entity for the given id
id | string Id of the entity which should be returned |
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
{- "$_type": "Account",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "name": "string",
- "billingAddress": "string",
- "contactAddress": "string",
- "avatar": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}
}
Gets a list of entities for the given id's
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
The id's for which the entities should be fetched
[- "string"
]
[- {
- "$_type": "Account",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "name": "string",
- "billingAddress": "string",
- "contactAddress": "string",
- "avatar": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}
}
]
Search for accounts
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
$_type | string Default: "AccountQuery" Value: "AccountQuery" |
Array of any (AccountSearchFilter) [ items ] List of filters to narrow the search of entities | |
Array of objects (AccountOrderBy) [ items ] List of criteria to order the search result list | |
offset | integer <int32> Offset position in the result set to start pagination |
limit | integer <int32> Maximal amount of items returned |
{- "$_type": "AccountQuery",
- "searchFilters": [
- {
- "$_type": "CreationTimestampAccountSearchFilter",
- "field": "NAME",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
], - "orderBy": [
- {
- "$_type": "AccountOrderBy",
- "field": "ID",
- "order": "ASCENDING"
}
], - "offset": 0,
- "limit": 0
}
{- "$_type": "AccountResult",
- "hasMoreItems": true,
- "nextOffset": 0,
- "items": [
- {
- "$_type": "Account",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "name": "string",
- "billingAddress": "string",
- "contactAddress": "string",
- "avatar": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}
}
]
}
Allows to update the current account as admin. If user is super admin, he can also update other accounts
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
The account entity to update
$_type | string Default: "Account" Value: "Account" |
id | string Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway. |
creationTimestamp | integer <int64> Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
modificationTimestamp | integer <int64> Timestamp of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
version | integer <int64> Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted. |
name | string The name of the account. Maximum length of 250 characters and can not be empty. |
string or Address (object) expand-query-key: billingAddress type: ExpandableField The id to an address which is used for billing, if the contact address should not be used. Should be null, if only contact address should be used. | |
string or Address (object) expand-query-key: contactAddress type: ExpandableField The id of the contact address for the account. Is also used for billing if no extra billing address is defined. | |
string or Avatar (object) expand-query-key: avatar type: ExpandableField Avatar of the entity: id that can be expanded. | |
object expand-query-key: configuration type: Map The entity's configuration properties. Only contains values when the 'expand' query parameter is used with the value 'configuration'. | |
object expand-query-key: metadata type: Map The entity's metadata properties. Only contains values when the 'expand' query parameter is used with the value 'metadata'. | |
object expand-query-key: text type: Map The entity's text properties. Only contains values when the 'expand' query parameter is used with the value 'text'. |
{- "$_type": "Account",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "name": "string",
- "billingAddress": "string",
- "contactAddress": "string",
- "avatar": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}
}
{- "$_type": "Account",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "name": "string",
- "billingAddress": "string",
- "contactAddress": "string",
- "avatar": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}
}
Creates the given entity in the system. The id of the entity can not be set for create operation, a new one is generated.
The entity to create
$_type | string Default: "Address" Value: "Address" |
id | string Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway. |
creationTimestamp | integer <int64> Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
modificationTimestamp | integer <int64> Timestamp of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
version | integer <int64> Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted. |
accountId | string Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
organisationName | string Name of the organisation. Maximum of 250 characters. Can be omitted. |
addressLine1 | string First address line. Maximum of 250 characters. Can be omitted. |
addressLine2 | string Second address line. Maximum of 250 characters. Can be omitted. |
zip | string Zip code of the city. Maximum of 20 characters. Can not be omitted. |
city | string City name. Maximum of 250 characters. Can not be omitted. |
state | string Country state. Maximum of 250 characters. Can be omitted. |
country | string Country. Maximum of 250 characters. Can not be omitted. |
{- "$_type": "Address",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "organisationName": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "zip": "string",
- "city": "string",
- "state": "string",
- "country": "string"
}
{- "$_type": "Address",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "organisationName": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "zip": "string",
- "city": "string",
- "state": "string",
- "country": "string"
}
Deletes the entity for the given id
id | string The id of the entity which should be deleted |
{- "$_type": "Error",
- "statusCode": 0,
- "statusDescription": "string",
- "errorMessage": "string"
}
Returns the entity for the given id
id | string Id of the entity which should be returned |
{- "$_type": "Address",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "organisationName": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "zip": "string",
- "city": "string",
- "state": "string",
- "country": "string"
}
Gets a list of entities for the given id's
The id's for which the entities should be fetched
[- "string"
]
[- {
- "$_type": "Address",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "organisationName": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "zip": "string",
- "city": "string",
- "state": "string",
- "country": "string"
}
]
Search for addresses in the current account
$_type | string Default: "AddressQuery" Value: "AddressQuery" |
Array of any (AddressSearchFilter) [ items ] List of filters to narrow the search of entities | |
Array of objects (AddressOrderBy) [ items ] List of criteria to order the search result list | |
offset | integer <int32> Offset position in the result set to start pagination |
limit | integer <int32> Maximal amount of items returned |
{- "$_type": "AddressQuery",
- "searchFilters": [
- {
- "$_type": "CreationTimestampAddressSearchFilter",
- "field": "CREATION_TIMESTAMP",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
], - "orderBy": [
- {
- "$_type": "AddressOrderBy",
- "field": "ID",
- "order": "ASCENDING"
}
], - "offset": 0,
- "limit": 0
}
{- "$_type": "AddressResult",
- "hasMoreItems": true,
- "nextOffset": 0,
- "items": [
- {
- "$_type": "Address",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "organisationName": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "zip": "string",
- "city": "string",
- "state": "string",
- "country": "string"
}
]
}
Updates the entity in the system with the given entity.
The entity to update
$_type | string Default: "Address" Value: "Address" |
id | string Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway. |
creationTimestamp | integer <int64> Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
modificationTimestamp | integer <int64> Timestamp of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
version | integer <int64> Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted. |
accountId | string Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
organisationName | string Name of the organisation. Maximum of 250 characters. Can be omitted. |
addressLine1 | string First address line. Maximum of 250 characters. Can be omitted. |
addressLine2 | string Second address line. Maximum of 250 characters. Can be omitted. |
zip | string Zip code of the city. Maximum of 20 characters. Can not be omitted. |
city | string City name. Maximum of 250 characters. Can not be omitted. |
state | string Country state. Maximum of 250 characters. Can be omitted. |
country | string Country. Maximum of 250 characters. Can not be omitted. |
{- "$_type": "Address",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "organisationName": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "zip": "string",
- "city": "string",
- "state": "string",
- "country": "string"
}
{- "$_type": "Address",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "organisationName": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "zip": "string",
- "city": "string",
- "state": "string",
- "country": "string"
}
Creates the given entity in the system. The id of the entity can not be set for create operation, a new one is generated.
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
The entity to create
$_type | string Default: "ApiKey" Value: "ApiKey" |
id | string Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway. |
creationTimestamp | integer <int64> Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
modificationTimestamp | integer <int64> Timestamp of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
version | integer <int64> Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted. |
accountId | string Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
apiKey | string Api key string. When creating the entity it can be set to a specific value or omitted (in the second case a random value will be generated by the server). Can not be updated. |
name | string Name of the api key. Maximum of 250 characters. Can be omitted, but should not. |
description | string Description of the api key. E.g. where or for what it is used. Maximum of 500 characters. Can be omitted. |
object expand-query-key: configuration type: Map The entity's configuration properties. Only contains values when the 'expand' query parameter is used with the value 'configuration'. | |
object expand-query-key: text type: Map The entity's text properties. Only contains values when the 'expand' query parameter is used with the value 'text'. | |
object expand-query-key: metadata type: Map The entity's metadata properties. Only contains values when the 'expand' query parameter is used with the value 'metadata'. |
{- "$_type": "ApiKey",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "apiKey": "string",
- "name": "string",
- "description": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
{- "$_type": "ApiKey",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "apiKey": "string",
- "name": "string",
- "description": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
Deletes the entity for the given id
id | string The id of the entity which should be deleted |
{- "$_type": "Error",
- "statusCode": 0,
- "statusDescription": "string",
- "errorMessage": "string"
}
Returns the api key object for the given api key string in the current account
apiKey | string The api key for which the object should be returned |
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
{- "$_type": "ApiKey",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "apiKey": "string",
- "name": "string",
- "description": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
Returns the default api key for the given account id. If the id of the account does not match with the one from the current user, null is returned
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
{- "$_type": "ApiKey",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "apiKey": "string",
- "name": "string",
- "description": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
Returns the entity for the given id
id | string Id of the entity which should be returned |
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
{- "$_type": "ApiKey",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "apiKey": "string",
- "name": "string",
- "description": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
Gets a list of entities for the given id's
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
The id's for which the entities should be fetched
[- "string"
]
[- {
- "$_type": "ApiKey",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "apiKey": "string",
- "name": "string",
- "description": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
]
Search for api keys in the current account
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
$_type | string Default: "ApiKeyQuery" Value: "ApiKeyQuery" |
Array of any (ApiKeySearchFilter) [ items ] List of filters to narrow the search of entities | |
Array of objects (ApiKeyOrderBy) [ items ] List of criteria to order the search result list | |
offset | integer <int32> Offset position in the result set to start pagination |
limit | integer <int32> Maximal amount of items returned |
{- "$_type": "ApiKeyQuery",
- "searchFilters": [
- {
- "$_type": "ApiKeyApiKeySearchFilter",
- "field": "NAME",
- "operator": {
- "$_type": "EqualsStringOperator",
- "type": "EQUALS",
- "value": "string"
}
}
], - "orderBy": [
- {
- "$_type": "ApiKeyOrderBy",
- "field": "ID",
- "order": "ASCENDING"
}
], - "offset": 0,
- "limit": 0
}
{- "$_type": "ApiKeyResult",
- "hasMoreItems": true,
- "nextOffset": 0,
- "items": [
- {
- "$_type": "ApiKey",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "apiKey": "string",
- "name": "string",
- "description": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
]
}
Updates the entity in the system with the given entity.
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
The entity to update
$_type | string Default: "ApiKey" Value: "ApiKey" |
id | string Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway. |
creationTimestamp | integer <int64> Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
modificationTimestamp | integer <int64> Timestamp of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
version | integer <int64> Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted. |
accountId | string Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
apiKey | string Api key string. When creating the entity it can be set to a specific value or omitted (in the second case a random value will be generated by the server). Can not be updated. |
name | string Name of the api key. Maximum of 250 characters. Can be omitted, but should not. |
description | string Description of the api key. E.g. where or for what it is used. Maximum of 500 characters. Can be omitted. |
object expand-query-key: configuration type: Map The entity's configuration properties. Only contains values when the 'expand' query parameter is used with the value 'configuration'. | |
object expand-query-key: text type: Map The entity's text properties. Only contains values when the 'expand' query parameter is used with the value 'text'. | |
object expand-query-key: metadata type: Map The entity's metadata properties. Only contains values when the 'expand' query parameter is used with the value 'metadata'. |
{- "$_type": "ApiKey",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "apiKey": "string",
- "name": "string",
- "description": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
{- "$_type": "ApiKey",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "apiKey": "string",
- "name": "string",
- "description": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
Service to log in with a user or to switch to other accounts/users by impersonating them
Authentication using a previously created authentication token from (createAuthenticationToken
). Will create an authentication session if authentication succeeds (includes setting an authentication cookie)
authenticationToken | string token to login with |
redirectOnSuccess | string redirection URL when the operation is successful |
redirectOnFailure | string redirection URL when the operation is not successful |
true
Changes password for currently logged in user, if the old password is currently matching the stored password
oldPassword | string The old password for validation |
newPassword | string The new password to set |
Change password
{- "oldPassword": "L0remPf18!",
- "newPassword": "L1rem_Hq23"
}
true
checks if a 'potential' password is valid given the current password policy
password | string Password to check against policy |
Check if the password will be accepted or not
{- "password": "L0remPf18!"
}
[- "string"
]
Creates a new authentication token, which can later be used for login.
username | string The username for which the token is created |
password | string The password of the user to authenticate |
Create a token for a given username and password
{- "username": "r@email.com",
- "password": "L0remPf18!"
}
"string"
Returns a compact user object, which contains the most important information about the current logged in user.
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
{- "$_type": "CompactUser",
- "id": "string",
- "accountId": "string",
- "username": "string",
- "displayName": "string",
- "firstName": "string",
- "lastName": "string",
- "avatar": "string",
- "teamId": "string",
- "parentTeamIds": [
- "string"
], - "permissions": {
- "$_type": "Permissions",
- "allPermissions": true,
- "permissions": [
- "string"
]
}, - "authorizationRole": "SUPER_ADMIN",
- "passwordDefined": true,
- "virtual": true,
- "propagated": true,
- "impersonatedFromUserId": "string",
- "impersonatedFromAccountId": "string"
}
Impersonates with another user either via username or userid (one of the two may be null).
username | string If set and userid is set to null, the user is searched by the name |
userId | string If set, the username is ignored and the user for the given id is impersonated |
superUser | boolean if true, the impersonated user will have the SUPER_ADMIN role (even if he hasn't normally). |
redirectOnSuccess | string redirection URL when the operation is successful |
redirectOnFailure | string redirection URL when the operation is not successful |
Impersonate as user 'admin' without keeping the superadmin rights
{- "username": "admin",
- "userId": null,
- "superUser": false,
- "redirectOnSuccess": null,
- "redirectOnFailure": null
}
true
Login using username and password credentials. Will create an authentication session if login succeeds (includes setting an authentication cookie)
username | string user to use for login |
password | string password to use for login |
redirectOnSuccess | string redirection URL when the operation is successful |
redirectOnFailure | string redirection URL when the operation is not successful |
Login with username and password
{- "username": "r@email.com",
- "password": "L0remPf18!",
- "redirectOnSuccess": null,
- "redirectOnFailure": null
}
true
Start a session using a signed JWT as the login credentials, a new user with role WEBUSER is automatically created. x-unblu-apikey
is a mandatory GET parameter for this operation, even though it is not part of the OpenAPI specification.
$_type | string Default: "SecureTokenRequest" Value: "SecureTokenRequest" |
token | string |
type | string (ESecureTokenType) Enum: "JWT" "OIDC_ACCESS_TOKEN" enum-descriptions: ["JWT","OIDC_ACCESS_TOKEN"] Token type |
{- "$_type": "SecureTokenRequest",
- "token": "string",
- "type": "JWT"
}
{- "$_type": "Error",
- "statusCode": 0,
- "statusDescription": "string",
- "errorMessage": "string"
}
Call this to logout (clear internal session and session cookie on response)
redirectOnSuccess | string redirection URL when the operation is successful |
Logout with a redirection to unblu.com
{
}
{- "$_type": "Error",
- "statusCode": 0,
- "statusDescription": "string",
- "errorMessage": "string"
}
Resets the current impersonation. Will do nothing if there is no impersonation.
redirectOnSuccess | string redirection URL when the operation is successful. Also if nothing needed to be done. |
redirectOnFailure | string redirection URL when the operation is not successful |
Reset impersonation and redirect to the Global Configuration page on success
{- "redirectOnSuccess": "/co-unblu/config-global",
- "redirectOnFailure": null
}
true
Sends a reset password link to the user by email only if the user exists
username | string The username of the user which receives a password reset mail |
Reset impersonation and redirect to the Global Configuration page on success
{- "username": "r@email.com"
}
{- "$_type": "Error",
- "statusCode": 0,
- "statusDescription": "string",
- "errorMessage": "string"
}
Changes the language of the current user. It is stored also in the returned cookies
Note: A reload should be done afterwards.
locale | string The new locale in the language-tag format (as defined in the IETF BCP 47) which should be used (e.g. en - english, de - german, fr - french, it - italian) |
Change the default locale to french
{- "locale": "fr"
}
{- "$_type": "Error",
- "statusCode": 0,
- "statusDescription": "string",
- "errorMessage": "string"
}
Saves a new password for the user behind the given authentication token. The token can be created withcreateAuthenticationToken
. The user needs to be authenticated first.
authenticationToken | string for authentication. |
password | string the new password to be used |
Set a new password
{- "authenticationToken": "Y2w5el...naW77w=",
- "password": "L0remPf18!"
}
{- "$_type": "Error",
- "statusCode": 0,
- "statusDescription": "string",
- "errorMessage": "string"
}
Switches the account in a given authentication session. If successful, the user is treated, as if he/she was a member of the target account.
accountId | string the account id to impersonate on |
redirectOnSuccess | string redirection URL when the operation is successful |
redirectOnFailure | string redirection URL when the operation is not successful |
Switch to account with a redirect to the Account Configuration page on success
{- "accountId": "A7d9E_0-c3cC4aoFDb85t6n",
- "redirectOnSuccess": "/co-unblu/config-account",
- "redirectOnFailure": null
}
true
Returns the current availability state a given named area and locale.
locale | string The locale in form of a BCP 47 language tag (including the region if available) to check the availability for. If omitted, the service will check the availability of agents who did not filter the queue by language. |
namedAreaSiteId | string The site ID (meta tag or domain) of the named area to check the availability for. If omitted, the service will check for the availability of agents who did not filter the queue by named area. |
apiKey | string API key to specify the account; mandatory when called as an anonymous user |
"AVAILABLE"
Creates the avatar in the system. The id can not be set for create operation, a new one is generated.
The entity to create
$_type | string Default: "Avatar" Value: "Avatar" |
id | string Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway. |
creationTimestamp | integer <int64> Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
modificationTimestamp | integer <int64> Timestamp of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
accountId | string Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
imageZoomFactor | number <float> Zoom factor to crop the original image. Must be bigger than 1. If omitted a minimal factor will be computed. |
imageXPositionRatio | number <float> Ratio to determine the horizontal position of the cropping area. Must be between 0 and 1: 0 means moved at the left border, 1 means moved at the right border. If omitted 0.5 will be used. |
imageYPositionRatio | number <float> Ratio to determine the vertical position of the cropping area. Must be between 0 and 1: 0 means moved at the top border, 1 means moved at the bottom border. If omitted 0.5 will be used. |
imageRotationAngle | integer <int32> Clockwise angle in degree (0-380) for rotation. If omitted 0 will be used. |
imageData | string Image content as data URL scheme (RFC2397 - |
{- "$_type": "Avatar",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "accountId": "string",
- "imageZoomFactor": 0,
- "imageXPositionRatio": 0,
- "imageYPositionRatio": 0,
- "imageRotationAngle": 0,
- "imageData": "string"
}
{- "$_type": "Avatar",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "accountId": "string",
- "imageZoomFactor": 0,
- "imageXPositionRatio": 0,
- "imageYPositionRatio": 0,
- "imageRotationAngle": 0,
- "imageData": "string"
}
Returns the avatar for the given id
id | string Id of the entity which should be returned |
{- "$_type": "Avatar",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "accountId": "string",
- "imageZoomFactor": 0,
- "imageXPositionRatio": 0,
- "imageYPositionRatio": 0,
- "imageRotationAngle": 0,
- "imageData": "string"
}
Service to manage all kind of bots. Additionally the bots use this service to interact with a conversation/dialog.
Accepts a dialog offer that was triggered either via a BotOnboardingOfferEvent
, BotReboardingOfferEvent
or a BotOffboardingOfferEvent
webhook.
Accepting the dialog offer will result in the dialog bot participating in the offered dialog. As soon as it is the dialogs turn it will receive aBotDialogOpenEvent
webhook.
dialogOfferToken | string the onboarding-, reboarding- or offboarding-offer token contained in the webhook. |
Accept dialog offer
{- "dialogOfferToken": "AcviDb210C5BoFd6e_79oan-c-diOogO6lQerZwXgjGQ1NCQ"
}
"string"
Cancels all pending questions in a bot dialog.
dialogToken | string The token belonging to the dialog |
{- "dialogToken": "string"
}
{- "$_type": "Error",
- "statusCode": 0,
- "statusDescription": "string",
- "errorMessage": "string"
}
Cancels a bot's question message. If the message is not from a bot, the call will throw an error.
conversationId | string The ID of the conversation the question message was sent to |
questionMessageId | string The ID of the question message that will be cancelled |
{- "conversationId": "string",
- "questionMessageId": "string"
}
{- "$_type": "Error",
- "statusCode": 0,
- "statusDescription": "string",
- "errorMessage": "string"
}
Creates a new dialog bot that can be used for conversation onboarding, reboarding and offboarding.
The dialog bot to create.
$_type | string Default: "DialogBotData" Value: "DialogBotData" |
id | string Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway. |
creationTimestamp | integer <int64> Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
modificationTimestamp | integer <int64> Timestamp of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
version | integer <int64> Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted. |
accountId | string Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
name | string Name of the dialog bot. Maximum length of 250 characters. Can not be omitted. |
description | string Description of the dialog bot. Maximum length of 500 characters. Can be omitted. |
botPersonId | string ID of the person representing the bot |
webhookStatus | string (ERegistrationStatus) Enum: "ACTIVE" "INACTIVE" "INACTIVE_UNAVAILABLE" enum-descriptions: ["ACTIVE: Registration is active","INACTIVE: Registration is not active","INACTIVE_UNAVAILABLE: Registration is not active, because it is unavailable"] Possible Webhook Registration Status |
webhookEndpoint | string The endpoint url of the webhook registration. To this url the requests for the webhook events are done. Maximum length of 4000 characters. Based on the configured filters/flags the following events will be sent to the endpoint:
|
webhookSecret | string Optional secret which is send with each webhook event. Maximum length of 4000 characters. |
onboardingOrder | integer <int32> Defines the onboarding order of this bot. If more than one bots want to participate in an onboarding, the one with the lowest order value will go first. |
reboardingOrder | integer <int32> Defines the reboarding order of this bot. If more than one bots want to participate in an reboarding, the one with the lowest order value will go first. |
offboardingOrder | integer <int32> Defines the offboarding priority of this bot. If more than one bots want to participate in an offboarding, the one with the lowest order value will go first. |
onboardingFilter | string (EBotDialogFilter) Enum: "VISITORS" "AGENTS" "BOTH" "NONE" enum-descriptions: ["VISITORS: Only handle dialogs that with visitors as the counterpart.","AGENTS: Only handle dialogs with agents as the counterpart","BOTH: Handle dialogs with both agents and visitors as the counterpart","NONE: Don't handle any dialogs."] |
reboardingEnabled | boolean Defines if this bot can reboard. A reboarding offer will be sent only if this flag is enabled, giving the bot the chance to be part of the reboarding. |
offboardingFilter | string (EBotDialogFilter) Enum: "VISITORS" "AGENTS" "BOTH" "NONE" enum-descriptions: ["VISITORS: Only handle dialogs that with visitors as the counterpart.","AGENTS: Only handle dialogs with agents as the counterpart","BOTH: Handle dialogs with both agents and visitors as the counterpart","NONE: Don't handle any dialogs."] |
needsCounterpartPresence | boolean Defines if the counterpart has to be online for the onboarding to start. E.g. if questions have to be answered live. |
messageStateHandledExternally | boolean Defines if the delivered/read state of messages is handled externally or by the collaboration server. |
onTimeoutBehavior | string (EBotDialogTimeoutBehavior) Enum: "ABORT" "HAND_OFF" enum-descriptions: ["ABORT: Abort on-boarding the conversation when it comes to timeout. Default for internal bots.","HAND_OFF: Proceed further in on-boarding the conversation when it comes to timeout. Default for external bots."] Defines what should happen with the conversation when it comes to timeout during on-boarding. |
Create a new dialog bot
{- "$_type": "DialogBotData",
- "id": null,
- "creationTimestamp": null,
- "modificationTimestamp": null,
- "version": null,
- "accountId": null,
- "name": "test-bot-1",
- "description": null,
- "botPersonId": "BoL9zZSbQeGGXMfCLxWZ4g",
- "webhookStatus": "INACTIVE",
- "webhookSecret": null,
- "onboardingOrder": 10,
- "reboardingOrder": 10,
- "offboardingOrder": 10,
- "onboardingFilter": "VISITORS",
- "reboardingEnabled": false,
- "offboardingFilter": "NONE",
- "needsCounterpartPresence": false,
- "messageStateHandledExternally": false,
- "onTimeoutBehavior": "HAND_OFF"
}
New dialog bot
{- "$_type": "DialogBotData",
- "id": "c1a-ED06Dbat9daFBtC4l85",
- "creationTimestamp": 1546300800000,
- "modificationTimestamp": 1548979200000,
- "version": 1,
- "accountId": "A7d9E_0-c3cC4aoFDb85t6n",
- "name": "test-bot-1",
- "description": null,
- "botPersonId": "BoL9zZSbQeGGXMfCLxWZ4g",
- "webhookStatus": "INACTIVE",
- "webhookSecret": null,
- "onboardingOrder": 10,
- "reboardingOrder": 10,
- "offboardingOrder": 10,
- "onboardingFilter": "VISITORS",
- "reboardingEnabled": false,
- "offboardingFilter": "NONE",
- "needsCounterpartPresence": false,
- "messageStateHandledExternally": false,
- "onTimeoutBehavior": "HAND_OFF"
}
{- "$_type": "BotDialogClosedEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "dialogToken": "string"
}
Declines a dialog offer that was triggered either via a BotOnboardingOfferEvent
, BotReboardingOfferEvent
or aBotOffboardingOfferEvent
webhook.
No further webhooks will be sent for this dialog.
dialogOfferToken | string the onboarding-, reboarding- or offboarding-offer token contained in the webhook. |
Decline a dialog offer
{- "dialogOfferToken": "AcviDb210C5BoFd6e_79oan-c-diOogO6lQerZwXgjGQ1NCQ"
}
{- "$_type": "Error",
- "statusCode": 0,
- "statusDescription": "string",
- "errorMessage": "string"
}
Deletes an existing dialog bot.
id | string ID of the dialog bot. |
{- "$_type": "Error",
- "statusCode": 0,
- "statusDescription": "string",
- "errorMessage": "string"
}
Marks a message as delivered to the bot.
Note: If the message is also read use the dialogMessageRead
end point directly as it will also mark the message as delivered.
dialogToken | string The token belonging to the dialog of the bot |
messageId | string The ID of the delivered message |
Mark a message as delivered
{- "dialogToken": "AcviDb210C5BoFd6e_79oan-c-daOogO9iQmqUbgNzZN4X2A",
- "messageId": "mGesYagET_2GipaDGinA9A"
}
{- "$_type": "Error",
- "statusCode": 0,
- "statusDescription": "string",
- "errorMessage": "string"
}
Marks a message as read to the bot.
Note: This will also mark the message as delivered, if this hasn't happened yet.
dialogToken | string The token belonging to the dialog of the bot |
messageId | string The ID of the message that was read |
Mark a message as read
{- "dialogToken": "AcviDb210C5BoFd6e_79oan-c-daOogO9iQmqUbgNzZN4X2A",
- "messageId": "mGesYagET_2GipaDGinA9A"
}
{- "$_type": "Error",
- "statusCode": 0,
- "statusDescription": "string",
- "errorMessage": "string"
}
Ends the dialog. Depending on the reason given and whether the dialog takes place during onboarding, reboarding, or offboarding, this will have specific effects. See the list below.
Reason: EBotDialogFinishReason.HAND_OFF
:
EBotDialogFinishReason.SOLVED
:EBotDialogFinishReason.ABORTED
:dialogToken | string The dialog token contained in each bot dialog webhook. |
reason | string (EBotDialogFinishReason) Enum: "HAND_OFF" "SOLVED" "ABORTED" enum-descriptions: ["HAND_OFF: The bot is done with his part and the next bot can to the on-, re- or offboarding.","SOLVED: The problem of the dialog was solved and therefore no further bots are invoked.","ABORTED: The dialog was not successful and the on-, re- or offboarding has to be aborted."] Reason why a bot finished a dialog. |
Hand off the dialog to an agent
{- "dialogToken": "AcviDb210C5BoFd6e_79oan-c-daOogO9iQmqUbgNzZN4X2A",
- "reason": "HAND_OFF"
}
{- "$_type": "Error",
- "statusCode": 0,
- "statusDescription": "string",
- "errorMessage": "string"
}
Searches for an existing dialog bot with the given name.
name | string Name of the dialog bot. |
Dialog bot
{- "$_type": "DialogBotData",
- "id": "c1a-ED06Dbat9daFBtC4l85",
- "creationTimestamp": 1546300800000,
- "modificationTimestamp": 1548979200000,
- "version": 1,
- "accountId": "A7d9E_0-c3cC4aoFDb85t6n",
- "name": "test-bot-1",
- "description": null,
- "botPersonId": "BoL9zZSbQeGGXMfCLxWZ4g",
- "webhookStatus": "INACTIVE",
- "webhookSecret": null,
- "onboardingOrder": 10,
- "reboardingOrder": 10,
- "offboardingOrder": 10,
- "onboardingFilter": "NONE",
- "reboardingEnabled": false,
- "offboardingFilter": "NONE",
- "needsCounterpartPresence": false,
- "messageStateHandledExternally": false,
- "onTimeoutBehavior": "HAND_OFF"
}
Emits a WebhookPingEvent
on the configured webhook for the dialog bot.
dialogBotId | string The ID of the dialog bot |
Send a ping event for the given bot
{- "dialogBotId": "c1a-ED06Dbat9daFBtC4l85"
}
{- "$_type": "Error",
- "statusCode": 0,
- "statusDescription": "string",
- "errorMessage": "string"
}
Reads an existing dialog bot.
id | string The ID of the dialog bot. |
Dialog bot
{- "$_type": "DialogBotData",
- "id": "c1a-ED06Dbat9daFBtC4l85",
- "creationTimestamp": 1546300800000,
- "modificationTimestamp": 1548979200000,
- "version": 1,
- "accountId": "A7d9E_0-c3cC4aoFDb85t6n",
- "name": "test-bot-1",
- "description": null,
- "botPersonId": "BoL9zZSbQeGGXMfCLxWZ4g",
- "webhookStatus": "INACTIVE",
- "webhookSecret": null,
- "onboardingOrder": 10,
- "reboardingOrder": 10,
- "offboardingOrder": 10,
- "onboardingFilter": "NONE",
- "reboardingEnabled": false,
- "offboardingFilter": "NONE",
- "needsCounterpartPresence": false,
- "messageStateHandledExternally": false,
- "onTimeoutBehavior": "HAND_OFF"
}
Search for dialog bots in the current account
$_type | string Default: "DialogBotQuery" Value: "DialogBotQuery" |
Array of any (DialogBotSearchFilter) [ items ] List of filters to narrow the search of entities | |
Array of objects (DialogBotOrderBy) [ items ] List of criteria to order the search result list | |
offset | integer <int32> Offset position in the result set to start pagination |
limit | integer <int32> Maximal amount of items returned |
{- "$_type": "DialogBotQuery",
- "searchFilters": [
- {
- "$_type": "CreationTimestampDialogBotSearchFilter",
- "field": "NAME",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
], - "orderBy": [
- {
- "$_type": "DialogBotOrderBy",
- "field": "ID",
- "order": "ASCENDING"
}
], - "offset": 0,
- "limit": 0
}
{- "$_type": "DialogBotResult",
- "hasMoreItems": true,
- "nextOffset": 0,
- "items": [
- {
- "$_type": "DialogBotData",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "name": "string",
- "description": "string",
- "botPersonId": "string",
- "webhookStatus": "ACTIVE",
- "webhookEndpoint": "string",
- "webhookSecret": "string",
- "onboardingOrder": 0,
- "reboardingOrder": 0,
- "offboardingOrder": 0,
- "onboardingFilter": "VISITORS",
- "reboardingEnabled": true,
- "offboardingFilter": "VISITORS",
- "needsCounterpartPresence": true,
- "messageStateHandledExternally": true,
- "onTimeoutBehavior": "ABORT"
}
]
}
Sends a message as a bot into an ongoing dialog.
It can only be used after the bot received the BotDialogOpenEvent
webhook for this dialog.
The message to send
$_type | string Default: "BotDialogPostMessage" Value: "BotDialogPostMessage" |
dialogToken | string The token belonging to the dialog the bot wants the message to |
any (PostMessageData) Base class for all conversation messages send to the collaboration server. |
{- "$_type": "BotDialogPostMessage",
- "dialogToken": "string",
- "messageData": {
- "$_type": "ListPostMessageData",
- "type": "TEXT",
- "fallbackText": "string",
- "header": {
- "$_type": "MessageHeader",
- "imageUrl": "string",
- "imageAltText": "string",
- "title": "string",
- "body": "string",
- "bodyTextType": "SIMPLE_TEXT"
}, - "items": [
- {
- "$_type": "PostListMessageCardItemData",
- "imageUrl": "string",
- "imageAltText": "string",
- "title": "string",
- "body": "string",
- "bodyTextType": "SIMPLE_TEXT",
- "action": {
- "$_type": "MessageAction",
- "actionType": "LINK_INTERNAL",
- "label": "string",
- "value": "string"
}
}
], - "actions": [
- {
- "$_type": "MessageAction",
- "actionType": "LINK_INTERNAL",
- "label": "string",
- "value": "string"
}
], - "quickReplies": [
- {
- "$_type": "QuickReply",
- "text": "string"
}
]
}
}
"string"
Sends a message to a conversation as a bot.
This can be used at any time during a conversation. It is not related to bot dialogs.
The message to send
$_type | string Default: "BotPostMessage" Value: "BotPostMessage" |
conversationId | string The id of the conversation to which this message belongs to |
senderPersonId | string ID of the bot person that sent the message. |
recipientPersonIds | Array of strings Person IDs of the recipients of the message. If it is null, all active participations are recipients |
any (PostMessageData) Base class for all conversation messages send to the collaboration server. |
Send card message from the bot
{- "$_type": "BotPostMessage",
- "conversationId": "AcviDb210C5BoFd6e_79oan",
- "senderPersonId": "nta30CBa-6d1a89cE57Db_F",
- "recipientPersonIds": [
- "PtwoVi1O-2G9FFCR_rZLKQ"
], - "messageData": {
- "$_type": "CardPostMessageData",
- "type": "CARD",
- "fallbackText": "This is the plain body text",
- "imageUrl": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAZAAAAGQBAMAAABykSv/AAAABGdBTUEAALGPC/xhBQAAAAFzUkdCAK7OHOkAAAASUExURfolAT39/6qSgZ2hko6xpLeDbrzfdCUAAAFvSURBVHja7c8BDYBADASwBQfvAAkkSOCRgH8rmLgwAq2D1lYZy+hVIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiLvjxx7xuyOjI8QERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERedB5hXRH1koRERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERH5S2Sm3Pdeq7vUBkC2AAAAAElFTkSuQmCC",
- "imageAltText": "test image",
- "title": "Title",
- "body": "This is the **body text** with markdown",
- "bodyTextType": "MARKDOWN",
- "actions": [
- {
- "$_type": "MessageAction",
- "actionType": "LINK_INTERNAL",
- "label": "Unblu homepage",
}, - {
- "$_type": "MessageAction",
- "actionType": "LINK_EXTERNAL",
- "label": "Wikipedia",
}, - {
- "$_type": "MessageAction",
- "actionType": "REPLY_MESSAGE",
- "label": "More info",
- "value": "Could you provide me with more info?"
}
], - "quickReplies": [
- {
- "$_type": "QuickReply",
- "text": "Thank you"
}, - {
- "$_type": "QuickReply",
- "text": "Great, that helped a lot"
}
]
}
}
"string"
Updates an existing dialog bot.
$_type | string Default: "DialogBotData" Value: "DialogBotData" |
id | string Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway. |
creationTimestamp | integer <int64> Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
modificationTimestamp | integer <int64> Timestamp of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
version | integer <int64> Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted. |
accountId | string Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
name | string Name of the dialog bot. Maximum length of 250 characters. Can not be omitted. |
description | string Description of the dialog bot. Maximum length of 500 characters. Can be omitted. |
botPersonId | string ID of the person representing the bot |
webhookStatus | string (ERegistrationStatus) Enum: "ACTIVE" "INACTIVE" "INACTIVE_UNAVAILABLE" enum-descriptions: ["ACTIVE: Registration is active","INACTIVE: Registration is not active","INACTIVE_UNAVAILABLE: Registration is not active, because it is unavailable"] Possible Webhook Registration Status |
webhookEndpoint | string The endpoint url of the webhook registration. To this url the requests for the webhook events are done. Maximum length of 4000 characters. Based on the configured filters/flags the following events will be sent to the endpoint:
|
webhookSecret | string Optional secret which is send with each webhook event. Maximum length of 4000 characters. |
onboardingOrder | integer <int32> Defines the onboarding order of this bot. If more than one bots want to participate in an onboarding, the one with the lowest order value will go first. |
reboardingOrder | integer <int32> Defines the reboarding order of this bot. If more than one bots want to participate in an reboarding, the one with the lowest order value will go first. |
offboardingOrder | integer <int32> Defines the offboarding priority of this bot. If more than one bots want to participate in an offboarding, the one with the lowest order value will go first. |
onboardingFilter | string (EBotDialogFilter) Enum: "VISITORS" "AGENTS" "BOTH" "NONE" enum-descriptions: ["VISITORS: Only handle dialogs that with visitors as the counterpart.","AGENTS: Only handle dialogs with agents as the counterpart","BOTH: Handle dialogs with both agents and visitors as the counterpart","NONE: Don't handle any dialogs."] |
reboardingEnabled | boolean Defines if this bot can reboard. A reboarding offer will be sent only if this flag is enabled, giving the bot the chance to be part of the reboarding. |
offboardingFilter | string (EBotDialogFilter) Enum: "VISITORS" "AGENTS" "BOTH" "NONE" enum-descriptions: ["VISITORS: Only handle dialogs that with visitors as the counterpart.","AGENTS: Only handle dialogs with agents as the counterpart","BOTH: Handle dialogs with both agents and visitors as the counterpart","NONE: Don't handle any dialogs."] |
needsCounterpartPresence | boolean Defines if the counterpart has to be online for the onboarding to start. E.g. if questions have to be answered live. |
messageStateHandledExternally | boolean Defines if the delivered/read state of messages is handled externally or by the collaboration server. |
onTimeoutBehavior | string (EBotDialogTimeoutBehavior) Enum: "ABORT" "HAND_OFF" enum-descriptions: ["ABORT: Abort on-boarding the conversation when it comes to timeout. Default for internal bots.","HAND_OFF: Proceed further in on-boarding the conversation when it comes to timeout. Default for external bots."] Defines what should happen with the conversation when it comes to timeout during on-boarding. |
{- "$_type": "DialogBotData",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "name": "string",
- "description": "string",
- "botPersonId": "string",
- "webhookStatus": "ACTIVE",
- "webhookEndpoint": "string",
- "webhookSecret": "string",
- "onboardingOrder": 0,
- "reboardingOrder": 0,
- "offboardingOrder": 0,
- "onboardingFilter": "VISITORS",
- "reboardingEnabled": true,
- "offboardingFilter": "VISITORS",
- "needsCounterpartPresence": true,
- "messageStateHandledExternally": true,
- "onTimeoutBehavior": "ABORT"
}
{- "$_type": "DialogBotData",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "name": "string",
- "description": "string",
- "botPersonId": "string",
- "webhookStatus": "ACTIVE",
- "webhookEndpoint": "string",
- "webhookSecret": "string",
- "onboardingOrder": 0,
- "reboardingOrder": 0,
- "offboardingOrder": 0,
- "onboardingFilter": "VISITORS",
- "reboardingEnabled": true,
- "offboardingFilter": "VISITORS",
- "needsCounterpartPresence": true,
- "messageStateHandledExternally": true,
- "onTimeoutBehavior": "ABORT"
}
Service to manage canned responses.
The canned responses a user can edit and the once he can use for chat can differ. The once he can edit are depending on his role. The ones he can use in a chat depends on the team setup and his role. See the following policies for the list of chat messages available for chat:
Creates the given entity in the system. The id of the entity can not be set for create operation, a new one is generated.
The entity to create
$_type | string Default: "CannedResponse" Value: "CannedResponse" |
id | string Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway. |
creationTimestamp | integer <int64> Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
modificationTimestamp | integer <int64> Timestamp of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
version | integer <int64> Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted. |
accountId | string Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
ownerId | string Id of the owner of the entity. Can not be omitted. |
ownerType | string (EPropertyOwnerType) Enum: "GLOBAL" "ACCOUNT" "TEAM" "USER" "AREA" "APIKEY" "PERSON" "CONVERSATION" "CONVERSATION_TEMPLATE" "EXTERNAL_MESSENGER_CHANNEL" enum-descriptions: ["GLOBAL: Global system is owner","ACCOUNT: Account is owner","TEAM: Team is owner","USER: User is owner","AREA: NamedArea is owner","APIKEY: ApiKey is owner","PERSON: Person","CONVERSATION: Conversation","CONVERSATION_TEMPLATE: Conversation template","EXTERNAL_MESSENGER_CHANNEL: External messenger channel"] Type of an owner of an entity |
key | string The key of a canned response to access it quickly. Maximum of 250 characters. Can not be omitted. |
title | string The title of a canned response. Maximum of 250 characters. Can be omitted, but should not. |
text | string The text of a canned response. Can be omitted, but should not. |
Create a new canned response for the account
{- "$_type": "CannedResponse",
- "id": null,
- "creationTimestamp": null,
- "modificationTimestamp": null,
- "version": null,
- "accountId": null,
- "ownerId": null,
- "ownerType": "ACCOUNT",
- "key": "niceDay",
- "title": "Have a nice day",
- "text": "It was great chatting with you, have a nice day!"
}
New canned response for the account
{- "$_type": "CannedResponse",
- "id": "EasFde6CRn83pnBCec_4Ds0",
- "creationTimestamp": 1546300800000,
- "modificationTimestamp": 1548979200000,
- "version": 1,
- "accountId": "A7d9E_0-c3cC4aoFDb85t6n",
- "ownerId": "A7d9E_0-c3cC4aoFDb85t6n",
- "ownerType": "ACCOUNT",
- "key": "niceDay",
- "title": "Have a nice day",
- "text": "It was great chatting with you, have a nice day!"
}
Deletes the entity for the given id
id | string The id of the entity which should be deleted |
{- "$_type": "Error",
- "statusCode": 0,
- "statusDescription": "string",
- "errorMessage": "string"
}
Returns all CannedResponses that are available inside chat sessions for the calling user.
The user may be allowed to edit more than the returned canned responses if he has the rights.
Note: For editing use the getByOwnerTypeAndId
or getAll
service.
[- {
- "$_type": "CannedResponse",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "ownerId": "string",
- "ownerType": "GLOBAL",
- "key": "string",
- "title": "string",
- "text": "string"
}
]
Returns a list of all configuration scopes for which the calling user may add, delete or edits canned responses. Depending on the permissions of the users, these configuration scopes can be more then the ones which are available for the user in a chat.
[- {
- "$_type": "CannedResponseConfigurationScope",
- "name": "string",
- "ownerId": "string",
- "ownerType": "GLOBAL"
}
]
Returns all configurations scopes available for chat to the calling user that the calling user may add, delete and edit canned responses for.
Note: The returned scopes may be equal to or be a subset of the the scopes returned by getWritableConfigurationScopes
depending on the user role.
[- {
- "$_type": "CannedResponseConfigurationScope",
- "name": "string",
- "ownerId": "string",
- "ownerType": "GLOBAL"
}
]
Returns the canned response for the given id
id | string Id of the canned response which should be returned |
{- "$_type": "CannedResponse",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "ownerId": "string",
- "ownerType": "GLOBAL",
- "key": "string",
- "title": "string",
- "text": "string"
}
Gets a list of canned responses for the given id's
The id's for which the canned responses should be fetched
[- "string"
]
[- {
- "$_type": "CannedResponse",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "ownerId": "string",
- "ownerType": "GLOBAL",
- "key": "string",
- "title": "string",
- "text": "string"
}
]
Search for domains in the current account
$_type | string Default: "CannedResponseQuery" Value: "CannedResponseQuery" |
Array of any (CannedResponseSearchFilter) [ items ] List of filters to narrow the search of entities | |
Array of objects (CannedResponseOrderBy) [ items ] List of criteria to order the search result list | |
offset | integer <int32> Offset position in the result set to start pagination |
limit | integer <int32> Maximal amount of items returned |
{- "$_type": "CannedResponseQuery",
- "searchFilters": [
- {
- "$_type": "CreationTimestampCannedResponseSearchFilter",
- "field": "KEY",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
], - "orderBy": [
- {
- "$_type": "CannedResponseOrderBy",
- "field": "ID",
- "order": "ASCENDING"
}
], - "offset": 0,
- "limit": 0
}
{- "$_type": "CannedResponseResult",
- "hasMoreItems": true,
- "nextOffset": 0,
- "items": [
- {
- "$_type": "CannedResponse",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "ownerId": "string",
- "ownerType": "GLOBAL",
- "key": "string",
- "title": "string",
- "text": "string"
}
]
}
Updates the entity in the system with the given entity.
The entity to update
$_type | string Default: "CannedResponse" Value: "CannedResponse" |
id | string Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway. |
creationTimestamp | integer <int64> Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
modificationTimestamp | integer <int64> Timestamp of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
version | integer <int64> Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted. |
accountId | string Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
ownerId | string Id of the owner of the entity. Can not be omitted. |
ownerType | string (EPropertyOwnerType) Enum: "GLOBAL" "ACCOUNT" "TEAM" "USER" "AREA" "APIKEY" "PERSON" "CONVERSATION" "CONVERSATION_TEMPLATE" "EXTERNAL_MESSENGER_CHANNEL" enum-descriptions: ["GLOBAL: Global system is owner","ACCOUNT: Account is owner","TEAM: Team is owner","USER: User is owner","AREA: NamedArea is owner","APIKEY: ApiKey is owner","PERSON: Person","CONVERSATION: Conversation","CONVERSATION_TEMPLATE: Conversation template","EXTERNAL_MESSENGER_CHANNEL: External messenger channel"] Type of an owner of an entity |
key | string The key of a canned response to access it quickly. Maximum of 250 characters. Can not be omitted. |
title | string The title of a canned response. Maximum of 250 characters. Can be omitted, but should not. |
text | string The text of a canned response. Can be omitted, but should not. |
{- "$_type": "CannedResponse",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "ownerId": "string",
- "ownerType": "GLOBAL",
- "key": "string",
- "title": "string",
- "text": "string"
}
{- "$_type": "CannedResponse",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "ownerId": "string",
- "ownerType": "GLOBAL",
- "key": "string",
- "title": "string",
- "text": "string"
}
Creates the given entity in the system. The id of the entity can not be set for create operation, a new one is generated.
The entity to create
$_type | string Default: "Contact" Value: "Contact" |
id | string Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway. |
creationTimestamp | integer <int64> Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
modificationTimestamp | integer <int64> Timestamp of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
version | integer <int64> Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted. |
accountId | string Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
ownerId | string Id of the owner of the entity. Can not be omitted. |
ownerType | string (EPropertyOwnerType) Enum: "GLOBAL" "ACCOUNT" "TEAM" "USER" "AREA" "APIKEY" "PERSON" "CONVERSATION" "CONVERSATION_TEMPLATE" "EXTERNAL_MESSENGER_CHANNEL" enum-descriptions: ["GLOBAL: Global system is owner","ACCOUNT: Account is owner","TEAM: Team is owner","USER: User is owner","AREA: NamedArea is owner","APIKEY: ApiKey is owner","PERSON: Person","CONVERSATION: Conversation","CONVERSATION_TEMPLATE: Conversation template","EXTERNAL_MESSENGER_CHANNEL: External messenger channel"] Type of an owner of an entity |
type | string (EContactType) Enum: "UNKNOWN_PHONE" "MOBILE_PHONE" "FIXNET_PHONE" "EMAIL" "URL" enum-descriptions: ["UNKNOWN_PHONE: Any phone number (fixnet, mobile,...)","MOBILE_PHONE: Mobile phone number","FIXNET_PHONE: Fixnet phone number","EMAIL: email address","URL: Url (e.g. company homepage url)"] Type of a contact information |
data | string The data of the contact information. e.g. a phone number. It is used for presentation. Can not be omitted. |
rawData | string The raw data of the contact information. In most cases it is the same as the data field. Can not be omitted. |
{- "$_type": "Contact",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "ownerId": "string",
- "ownerType": "GLOBAL",
- "type": "UNKNOWN_PHONE",
- "data": "string",
- "rawData": "string"
}
{- "$_type": "Contact",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "ownerId": "string",
- "ownerType": "GLOBAL",
- "type": "UNKNOWN_PHONE",
- "data": "string",
- "rawData": "string"
}
Deletes the entity for the given id
id | string The id of the entity which should be deleted |
{- "$_type": "Error",
- "statusCode": 0,
- "statusDescription": "string",
- "errorMessage": "string"
}
Returns the entity for the given id
id | string Id of the entity which should be returned |
{- "$_type": "Contact",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "ownerId": "string",
- "ownerType": "GLOBAL",
- "type": "UNKNOWN_PHONE",
- "data": "string",
- "rawData": "string"
}
Gets a list of entities for the given id's
The id's for which the entities should be fetched
[- "string"
]
[- {
- "$_type": "Contact",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "ownerId": "string",
- "ownerType": "GLOBAL",
- "type": "UNKNOWN_PHONE",
- "data": "string",
- "rawData": "string"
}
]
Search for contacts in the current account
$_type | string Default: "ContactQuery" Value: "ContactQuery" |
Array of any (ContactSearchFilter) [ items ] List of filters to narrow the search of entities | |
Array of objects (ContactOrderBy) [ items ] List of criteria to order the search result list | |
offset | integer <int32> Offset position in the result set to start pagination |
limit | integer <int32> Maximal amount of items returned |
{- "$_type": "ContactQuery",
- "searchFilters": [
- {
- "$_type": "CreationTimestampContactSearchFilter",
- "field": "CREATION_TIMESTAMP",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
], - "orderBy": [
- {
- "$_type": "ContactOrderBy",
- "field": "ID",
- "order": "ASCENDING"
}
], - "offset": 0,
- "limit": 0
}
{- "$_type": "ContactResult",
- "hasMoreItems": true,
- "nextOffset": 0,
- "items": [
- {
- "$_type": "Contact",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "ownerId": "string",
- "ownerType": "GLOBAL",
- "type": "UNKNOWN_PHONE",
- "data": "string",
- "rawData": "string"
}
]
}
Updates the entity in the system with the given entity.
The entity to update
$_type | string Default: "Contact" Value: "Contact" |
id | string Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway. |
creationTimestamp | integer <int64> Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
modificationTimestamp | integer <int64> Timestamp of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
version | integer <int64> Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted. |
accountId | string Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
ownerId | string Id of the owner of the entity. Can not be omitted. |
ownerType | string (EPropertyOwnerType) Enum: "GLOBAL" "ACCOUNT" "TEAM" "USER" "AREA" "APIKEY" "PERSON" "CONVERSATION" "CONVERSATION_TEMPLATE" "EXTERNAL_MESSENGER_CHANNEL" enum-descriptions: ["GLOBAL: Global system is owner","ACCOUNT: Account is owner","TEAM: Team is owner","USER: User is owner","AREA: NamedArea is owner","APIKEY: ApiKey is owner","PERSON: Person","CONVERSATION: Conversation","CONVERSATION_TEMPLATE: Conversation template","EXTERNAL_MESSENGER_CHANNEL: External messenger channel"] Type of an owner of an entity |
type | string (EContactType) Enum: "UNKNOWN_PHONE" "MOBILE_PHONE" "FIXNET_PHONE" "EMAIL" "URL" enum-descriptions: ["UNKNOWN_PHONE: Any phone number (fixnet, mobile,...)","MOBILE_PHONE: Mobile phone number","FIXNET_PHONE: Fixnet phone number","EMAIL: email address","URL: Url (e.g. company homepage url)"] Type of a contact information |
data | string The data of the contact information. e.g. a phone number. It is used for presentation. Can not be omitted. |
rawData | string The raw data of the contact information. In most cases it is the same as the data field. Can not be omitted. |
{- "$_type": "Contact",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "ownerId": "string",
- "ownerType": "GLOBAL",
- "type": "UNKNOWN_PHONE",
- "data": "string",
- "rawData": "string"
}
{- "$_type": "Contact",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "ownerId": "string",
- "ownerType": "GLOBAL",
- "type": "UNKNOWN_PHONE",
- "data": "string",
- "rawData": "string"
}
Returns the conversation history data for a given conversation.
conversationId | string id of the conversation |
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
{- "$_type": "ConversationHistoryData",
- "id": "string",
- "recipient": {
- "$_type": "AccountData",
- "id": "string",
- "displayName": "string",
- "avatar": "string"
}, - "assigneePerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "contextPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "endPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "participants": [
- {
- "$_type": "ParticipantHistoryData",
- "state": "CREATED",
- "createdTimestamp": 0,
- "joinedTimestamp": 0,
- "activationTimestamp": 0,
- "offboardingTimestamp": 0,
- "leftTimestamp": 0,
- "conversationRating": 0,
- "isHidden": true,
- "conversationStarred": true,
- "person": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}
}
], - "createdTimestamp": 0,
- "onboardingTimestamp": 0,
- "activationTimestamp": 0,
- "assigneeJoinTimestamp": 0,
- "reboardingTimestamp": 0,
- "offboardingTimestamp": 0,
- "endTimestamp": 0,
- "queuedTimestamp": 0,
- "state": "CREATED",
- "initialEngagementType": "CHAT_REQUEST",
- "locale": "string",
- "endReason": "ENDED_BY_PARTICIPANT",
- "tokboxSessionId": "string",
- "conversationTemplateId": "string",
- "externalMessengerChannelIconId": "string",
- "externalMessengerChannelName": "string"
}
Generic conversation history search.
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
The Conversation history query.
$_type | string Default: "ConversationQuery" Value: "ConversationQuery" |
Array of any (ConversationSearchFilter) [ items ] List of filters to narrow the search of entities | |
Array of objects (ConversationOrderBy) [ items ] List of criteria to order the search result list | |
offset | integer <int32> Offset position in the result set to start pagination |
limit | integer <int32> Maximal amount of items returned |
{- "$_type": "ConversationQuery",
- "searchFilters": [
- {
- "$_type": "ParticipantPersonIdConversationSearchFilter",
- "field": "CREATION_TIMESTAMP",
- "operator": {
- "$_type": "AllOfIdListOperator",
- "type": "ALL_OF",
- "values": [
- "string"
]
}
}
], - "orderBy": [
- {
- "$_type": "ConversationOrderBy",
- "field": "CREATION_TIMESTAMP",
- "order": "ASCENDING"
}
], - "offset": 0,
- "limit": 0
}
[- {
- "$_type": "ConversationHistoryData",
- "id": "string",
- "recipient": {
- "$_type": "AccountData",
- "id": "string",
- "displayName": "string",
- "avatar": "string"
}, - "assigneePerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "contextPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "endPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "participants": [
- {
- "$_type": "ParticipantHistoryData",
- "state": "CREATED",
- "createdTimestamp": 0,
- "joinedTimestamp": 0,
- "activationTimestamp": 0,
- "offboardingTimestamp": 0,
- "leftTimestamp": 0,
- "conversationRating": 0,
- "isHidden": true,
- "conversationStarred": true,
- "person": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}
}
], - "createdTimestamp": 0,
- "onboardingTimestamp": 0,
- "activationTimestamp": 0,
- "assigneeJoinTimestamp": 0,
- "reboardingTimestamp": 0,
- "offboardingTimestamp": 0,
- "endTimestamp": 0,
- "queuedTimestamp": 0,
- "state": "CREATED",
- "initialEngagementType": "CHAT_REQUEST",
- "locale": "string",
- "endReason": "ENDED_BY_PARTICIPANT",
- "tokboxSessionId": "string",
- "conversationTemplateId": "string",
- "externalMessengerChannelIconId": "string",
- "externalMessengerChannelName": "string"
}
]
Search messages belonging to a specific conversation
conversationId required | string id of the conversation |
$_type | string Default: "MessageQuery" Value: "MessageQuery" |
Array of any (MessageSearchFilter) [ items ] List of filters to narrow the search of entities | |
Array of objects (MessageOrderBy) [ items ] List of criteria to order the search result list | |
offset | integer <int32> Offset position in the result set to start pagination |
limit | integer <int32> Maximal amount of items returned |
{- "$_type": "MessageQuery",
- "searchFilters": [
- {
- "$_type": "SendTimestampMessageSearchFilter",
- "field": "SEND_TIMESTAMP",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
], - "orderBy": [
- {
- "$_type": "MessageOrderBy",
- "field": "ID",
- "order": "ASCENDING"
}
], - "offset": 0,
- "limit": 0
}
{- "$_type": "MessageResult",
- "hasMoreItems": true,
- "nextOffset": 0,
- "items": [
- {
- "$_type": "ConversationHistoryMessageData",
- "id": "string",
- "conversationId": "string",
- "sendTimestamp": 0,
- "serverTimestamp": 0,
- "senderPersonId": "string",
- "type": "TEXT",
- "recipientPersonIds": [
- "string"
], - "text": "string"
}
]
}
Creates the given entity in the system. The id of the entity can not be set for create operation, a new one is generated.
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
The entity to create
$_type | string Default: "ConversationTemplate" Value: "ConversationTemplate" |
id | string Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway. |
creationTimestamp | integer <int64> Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
modificationTimestamp | integer <int64> Timestamp of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
version | integer <int64> Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted. |
accountId | string Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
name | string Name of the named area. Maximum of 250 characters. Can not be omitted. |
description | string Description of the named area. Maximum of 500 characters. Can be omitted. |
defaultTemplate | boolean If true, this will be the default template for the initial engagement Type |
initialEngagementType | string (EInitialEngagementType) Enum: "CHAT_REQUEST" "OFFLINE_CHAT_REQUEST" "VIDEO_REQUEST" "AUDIO_REQUEST" "HEADLESS_BROWSER_REQUEST" "DOMCAP_BROWSER_REQUEST" "MOBILE_COBROWSING_REQUEST" "SCREEN_SHARING_REQUEST" "VISITOR_COBROWSING" "HEADLESS_PIN" "DOMCAP_PIN" "MOBILE_PIN" "SCREEN_SHARING_PIN" "CHAT_INVITE" "HEADLESS_INVITE" "SCREEN_SHARING_INVITE" enum-descriptions: ["CHAT_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming chat conversation.","OFFLINE_CHAT_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming chat conversation while all agents are offline.","VIDEO_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming video conversation.","AUDIO_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming audio conversation.","HEADLESS_BROWSER_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming universal co-browsing conversation.","DOMCAP_BROWSER_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming embedded co-browsing conversation.","MOBILE_COBROWSING_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming mobile co-browsing conversation.","SCREEN_SHARING_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming screen sharing conversation.","VISITOR_COBROWSING: (Api initiated, visitor centered) A visitor creates a conversation via API which is not added to the queue and where he can invite other visitor to do embedded","HEADLESS_PIN: (Agent initiated, visitor centered) An agent creates a conversation with a PIN invitation for the visitor to join an universal co-browsing conversation.","DOMCAP_PIN: (Agent initiated, visitor centered) An agent creates a conversation with a PIN invitation for the visitor to join an embedded co-browsing conversation.","MOBILE_PIN: (Agent initiated, visitor centered) An agent creates a conversation with a PIN invitation for the visitor to join a mobile co-browsing conversation.","SCREEN_SHARING_PIN: (Agent initiated, visitor centered) An agent creates a conversation with a PIN invitation for the visitor to join a screen sharing conversation.","CHAT_INVITE: (Agent initiated, agent centered) An agent creates a chat conversation (this is the recommended initial engagement type for conversation created with the Web API).","HEADLESS_INVITE: (Agent initiated, agent centered) An agent creates universal co-browsing conversation and invites customer later.","SCREEN_SHARING_INVITE: (Agent initiated, agent centered) An agent creates screen sharing conversation and invites customer later."] The initial type of a conversation. The type used at creation time of the conversation determines the conversation template that is used. |
object expand-query-key: configuration type: Map The entity's configuration properties. Only contains values when the 'expand' query parameter is used with the value 'configuration'. | |
object expand-query-key: text type: Map The entity's text properties. Only contains values when the 'expand' query parameter is used with the value 'text'. | |
object expand-query-key: metadata type: Map The entity's metadata properties. Only contains values when the 'expand' query parameter is used with the value 'metadata'. |
{- "$_type": "ConversationTemplate",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "name": "string",
- "description": "string",
- "defaultTemplate": true,
- "initialEngagementType": "CHAT_REQUEST",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
{- "$_type": "ConversationTemplate",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "name": "string",
- "description": "string",
- "defaultTemplate": true,
- "initialEngagementType": "CHAT_REQUEST",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
Deletes the entity for the given id
id | string The id of the entity which should be deleted |
{- "$_type": "Error",
- "statusCode": 0,
- "statusDescription": "string",
- "errorMessage": "string"
}
Gets the default conversation template for a given initial engagement type
initialEngagementType | string (EInitialEngagementType) Enum: "CHAT_REQUEST" "OFFLINE_CHAT_REQUEST" "VIDEO_REQUEST" "AUDIO_REQUEST" "HEADLESS_BROWSER_REQUEST" "DOMCAP_BROWSER_REQUEST" "MOBILE_COBROWSING_REQUEST" "SCREEN_SHARING_REQUEST" "VISITOR_COBROWSING" "HEADLESS_PIN" "DOMCAP_PIN" "MOBILE_PIN" "SCREEN_SHARING_PIN" "CHAT_INVITE" "HEADLESS_INVITE" "SCREEN_SHARING_INVITE" enum-descriptions: ["CHAT_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming chat conversation.","OFFLINE_CHAT_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming chat conversation while all agents are offline.","VIDEO_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming video conversation.","AUDIO_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming audio conversation.","HEADLESS_BROWSER_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming universal co-browsing conversation.","DOMCAP_BROWSER_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming embedded co-browsing conversation.","MOBILE_COBROWSING_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming mobile co-browsing conversation.","SCREEN_SHARING_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming screen sharing conversation.","VISITOR_COBROWSING: (Api initiated, visitor centered) A visitor creates a conversation via API which is not added to the queue and where he can invite other visitor to do embedded","HEADLESS_PIN: (Agent initiated, visitor centered) An agent creates a conversation with a PIN invitation for the visitor to join an universal co-browsing conversation.","DOMCAP_PIN: (Agent initiated, visitor centered) An agent creates a conversation with a PIN invitation for the visitor to join an embedded co-browsing conversation.","MOBILE_PIN: (Agent initiated, visitor centered) An agent creates a conversation with a PIN invitation for the visitor to join a mobile co-browsing conversation.","SCREEN_SHARING_PIN: (Agent initiated, visitor centered) An agent creates a conversation with a PIN invitation for the visitor to join a screen sharing conversation.","CHAT_INVITE: (Agent initiated, agent centered) An agent creates a chat conversation (this is the recommended initial engagement type for conversation created with the Web API).","HEADLESS_INVITE: (Agent initiated, agent centered) An agent creates universal co-browsing conversation and invites customer later.","SCREEN_SHARING_INVITE: (Agent initiated, agent centered) An agent creates screen sharing conversation and invites customer later."] The initial type of a conversation. The type used at creation time of the conversation determines the conversation template that is used. |
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
{- "$_type": "ConversationTemplate",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "name": "string",
- "description": "string",
- "defaultTemplate": true,
- "initialEngagementType": "CHAT_REQUEST",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
Returns the entity for the given id
id | string Id of the entity which should be returned |
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
{- "$_type": "ConversationTemplate",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "name": "string",
- "description": "string",
- "defaultTemplate": true,
- "initialEngagementType": "CHAT_REQUEST",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
Gets a list of entities for the given id's
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
The id's for which the entities should be fetched
[- "string"
]
[- {
- "$_type": "ConversationTemplate",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "name": "string",
- "description": "string",
- "defaultTemplate": true,
- "initialEngagementType": "CHAT_REQUEST",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
]
Search for conversation-templates in the current account
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
$_type | string Default: "ConversationTemplateQuery" Value: "ConversationTemplateQuery" |
Array of any (ConversationTemplateSearchFilter) [ items ] List of filters to narrow the search of entities | |
Array of objects (ConversationTemplateOrderBy) [ items ] List of criteria to order the search result list | |
offset | integer <int32> Offset position in the result set to start pagination |
limit | integer <int32> Maximal amount of items returned |
{- "$_type": "ConversationTemplateQuery",
- "searchFilters": [
- {
- "$_type": "CreationTimestampConversationTemplateSearchFilter",
- "field": "NAME",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
], - "orderBy": [
- {
- "$_type": "ConversationTemplateOrderBy",
- "field": "ID",
- "order": "ASCENDING"
}
], - "offset": 0,
- "limit": 0
}
{- "$_type": "ConversationTemplateResult",
- "hasMoreItems": true,
- "nextOffset": 0,
- "items": [
- {
- "$_type": "ConversationTemplate",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "name": "string",
- "description": "string",
- "defaultTemplate": true,
- "initialEngagementType": "CHAT_REQUEST",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
]
}
Updates the entity in the system with the given entity.
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
The entity to update
$_type | string Default: "ConversationTemplate" Value: "ConversationTemplate" |
id | string Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway. |
creationTimestamp | integer <int64> Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
modificationTimestamp | integer <int64> Timestamp of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
version | integer <int64> Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted. |
accountId | string Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
name | string Name of the named area. Maximum of 250 characters. Can not be omitted. |
description | string Description of the named area. Maximum of 500 characters. Can be omitted. |
defaultTemplate | boolean If true, this will be the default template for the initial engagement Type |
initialEngagementType | string (EInitialEngagementType) Enum: "CHAT_REQUEST" "OFFLINE_CHAT_REQUEST" "VIDEO_REQUEST" "AUDIO_REQUEST" "HEADLESS_BROWSER_REQUEST" "DOMCAP_BROWSER_REQUEST" "MOBILE_COBROWSING_REQUEST" "SCREEN_SHARING_REQUEST" "VISITOR_COBROWSING" "HEADLESS_PIN" "DOMCAP_PIN" "MOBILE_PIN" "SCREEN_SHARING_PIN" "CHAT_INVITE" "HEADLESS_INVITE" "SCREEN_SHARING_INVITE" enum-descriptions: ["CHAT_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming chat conversation.","OFFLINE_CHAT_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming chat conversation while all agents are offline.","VIDEO_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming video conversation.","AUDIO_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming audio conversation.","HEADLESS_BROWSER_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming universal co-browsing conversation.","DOMCAP_BROWSER_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming embedded co-browsing conversation.","MOBILE_COBROWSING_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming mobile co-browsing conversation.","SCREEN_SHARING_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming screen sharing conversation.","VISITOR_COBROWSING: (Api initiated, visitor centered) A visitor creates a conversation via API which is not added to the queue and where he can invite other visitor to do embedded","HEADLESS_PIN: (Agent initiated, visitor centered) An agent creates a conversation with a PIN invitation for the visitor to join an universal co-browsing conversation.","DOMCAP_PIN: (Agent initiated, visitor centered) An agent creates a conversation with a PIN invitation for the visitor to join an embedded co-browsing conversation.","MOBILE_PIN: (Agent initiated, visitor centered) An agent creates a conversation with a PIN invitation for the visitor to join a mobile co-browsing conversation.","SCREEN_SHARING_PIN: (Agent initiated, visitor centered) An agent creates a conversation with a PIN invitation for the visitor to join a screen sharing conversation.","CHAT_INVITE: (Agent initiated, agent centered) An agent creates a chat conversation (this is the recommended initial engagement type for conversation created with the Web API).","HEADLESS_INVITE: (Agent initiated, agent centered) An agent creates universal co-browsing conversation and invites customer later.","SCREEN_SHARING_INVITE: (Agent initiated, agent centered) An agent creates screen sharing conversation and invites customer later."] The initial type of a conversation. The type used at creation time of the conversation determines the conversation template that is used. |
object expand-query-key: configuration type: Map The entity's configuration properties. Only contains values when the 'expand' query parameter is used with the value 'configuration'. | |
object expand-query-key: text type: Map The entity's text properties. Only contains values when the 'expand' query parameter is used with the value 'text'. | |
object expand-query-key: metadata type: Map The entity's metadata properties. Only contains values when the 'expand' query parameter is used with the value 'metadata'. |
{- "$_type": "ConversationTemplate",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "name": "string",
- "description": "string",
- "defaultTemplate": true,
- "initialEngagementType": "CHAT_REQUEST",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
{- "$_type": "ConversationTemplate",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "name": "string",
- "description": "string",
- "defaultTemplate": true,
- "initialEngagementType": "CHAT_REQUEST",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
Add a participant to a conversation.
conversationId required | string the conversation that is updated |
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
personId | string Id of the person to add |
connectedViaExternalMessenger | boolean If the participant is sending messages via a messenger channel, this parameter must be set to true. Otherwise false or do not set. |
hidden | boolean If the person should be hidden or not. Note: only secondary agents and bots may be hidden. |
conversationStarred | boolean If this conversation should be marked as starred for the person. If |
Add a participant to a conversation
{- "personId": "nta30CBa-6d1a89cE57Db_F",
- "connectedViaExternalMessenger": false,
- "hidden": false,
- "conversationStarred": false
}
{- "$_type": "ConversationData",
- "creationTimestamp": 0,
- "endTimestamp": 0,
- "id": "string",
- "accountId": "string",
- "topic": "string",
- "recipient": {
- "$_type": "AccountData",
- "id": "string",
- "displayName": "string",
- "avatar": "string"
}, - "participants": [
- {
- "$_type": "ParticipantData",
- "state": "CREATED",
- "personId": "string",
- "connectedViaExternalMessenger": true,
- "hidden": true,
- "conversationStarred": true
}
], - "assigneePersonId": "string",
- "contextPersonId": "string",
- "state": "CREATED",
- "initialEngagementType": "CHAT_REQUEST",
- "locale": "string",
- "tokboxSessionId": "string",
- "visitorData": "string",
- "conversationTemplateId": "string",
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
], - "externalMessengerChannelId": "string",
- "sourceId": "string",
- "endReason": "ENDED_BY_PARTICIPANT",
- "initialEngagementUrl": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
Changes the visibility of a conversation's participant.
conversationId required | string |
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
personId | string |
hidden | boolean |
Mark an agent as visible
{- "personId": "nta30CBa-6d1a89cE57Db_F",
- "hidden": false
}
{- "$_type": "ConversationData",
- "creationTimestamp": 0,
- "endTimestamp": 0,
- "id": "string",
- "accountId": "string",
- "topic": "string",
- "recipient": {
- "$_type": "AccountData",
- "id": "string",
- "displayName": "string",
- "avatar": "string"
}, - "participants": [
- {
- "$_type": "ParticipantData",
- "state": "CREATED",
- "personId": "string",
- "connectedViaExternalMessenger": true,
- "hidden": true,
- "conversationStarred": true
}
], - "assigneePersonId": "string",
- "contextPersonId": "string",
- "state": "CREATED",
- "initialEngagementType": "CHAT_REQUEST",
- "locale": "string",
- "tokboxSessionId": "string",
- "visitorData": "string",
- "conversationTemplateId": "string",
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
], - "externalMessengerChannelId": "string",
- "sourceId": "string",
- "endReason": "ENDED_BY_PARTICIPANT",
- "initialEngagementUrl": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
Creates the conversation in the system. The id of the conversation must not be set for the 'create' operation as a new one will be generated.
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
$_type | string Default: "ConversationData" Value: "ConversationData" |
creationTimestamp | integer <int64> Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. |
endTimestamp | integer <int64> utc timestamp when the conversation has ended (all participants have finished their offboarding). |
id | string Unique id of the conversation. When creating an entity this property can be omitted as it will be generated by the server anyway. |
accountId | string Account id to which the conversation belongs to. When creating a conversation, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
topic | string Topic of the conversation. Can be omitted. |
any (ConversationRecipientData) Recipient of a conversation: Either a single | |
Array of objects (ParticipantData) [ items ] Current participants of the conversation | |
assigneePersonId | string PersonId of the assignee, must be one of the participants |
contextPersonId | string PersonId of the main visitor, must be one of the participants |
state | string (EConversationState) Enum: "CREATED" "ONBOARDING" "REBOARDING" "QUEUED" "ACTIVE" "UNASSIGNED" "OFFBOARDING" "ENDED" enum-descriptions: ["CREATED: Initial state of a conversation","ONBOARDING: Depending of the engagement type of the conversation, the conversation stays in the onboarding state as long as the person in the center of the conversation is doing his onboarding","REBOARDING: When a message is send to an unassigned conversation, the conversation first is put into the reboarding state as long as the person in the center of the conversation is doing the reboarding.","QUEUED: Depending of the engagement type of the conversation, the conversation is put in the queued state when it is inside the queue.","ACTIVE: Conversation is active","UNASSIGNED: After there is no assignee of a conversation anymore, the conversation goes to unassigned state until a message from a visitor is written to start reboarding again.","OFFBOARDING: Conversation is being ended","ENDED: Conversation is ended"] Life cycle state of the conversation. Following transitions are possible:
|
initialEngagementType | string (EInitialEngagementType) Enum: "CHAT_REQUEST" "OFFLINE_CHAT_REQUEST" "VIDEO_REQUEST" "AUDIO_REQUEST" "HEADLESS_BROWSER_REQUEST" "DOMCAP_BROWSER_REQUEST" "MOBILE_COBROWSING_REQUEST" "SCREEN_SHARING_REQUEST" "VISITOR_COBROWSING" "HEADLESS_PIN" "DOMCAP_PIN" "MOBILE_PIN" "SCREEN_SHARING_PIN" "CHAT_INVITE" "HEADLESS_INVITE" "SCREEN_SHARING_INVITE" enum-descriptions: ["CHAT_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming chat conversation.","OFFLINE_CHAT_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming chat conversation while all agents are offline.","VIDEO_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming video conversation.","AUDIO_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming audio conversation.","HEADLESS_BROWSER_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming universal co-browsing conversation.","DOMCAP_BROWSER_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming embedded co-browsing conversation.","MOBILE_COBROWSING_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming mobile co-browsing conversation.","SCREEN_SHARING_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming screen sharing conversation.","VISITOR_COBROWSING: (Api initiated, visitor centered) A visitor creates a conversation via API which is not added to the queue and where he can invite other visitor to do embedded","HEADLESS_PIN: (Agent initiated, visitor centered) An agent creates a conversation with a PIN invitation for the visitor to join an universal co-browsing conversation.","DOMCAP_PIN: (Agent initiated, visitor centered) An agent creates a conversation with a PIN invitation for the visitor to join an embedded co-browsing conversation.","MOBILE_PIN: (Agent initiated, visitor centered) An agent creates a conversation with a PIN invitation for the visitor to join a mobile co-browsing conversation.","SCREEN_SHARING_PIN: (Agent initiated, visitor centered) An agent creates a conversation with a PIN invitation for the visitor to join a screen sharing conversation.","CHAT_INVITE: (Agent initiated, agent centered) An agent creates a chat conversation (this is the recommended initial engagement type for conversation created with the Web API).","HEADLESS_INVITE: (Agent initiated, agent centered) An agent creates universal co-browsing conversation and invites customer later.","SCREEN_SHARING_INVITE: (Agent initiated, agent centered) An agent creates screen sharing conversation and invites customer later."] The initial type of a conversation. The type used at creation time of the conversation determines the conversation template that is used. |
locale | string Locale of the conversation language (as BCP 47 language tag form including region if available) |
tokboxSessionId | string Tokbox sessionId. When creating a conversation this property can be omitted as it will be generated by the server anyway. |
visitorData | string Custom data for the visitor. This has no specific format. |
conversationTemplateId | string Template id of this conversation. If omitted, the default conversationTemplate will be retrieved based on the initialEngagementType |
Array of objects (ConversationLink) [ items ] Links to open the conversation. When creating a conversation this property can be omitted as it will be generated by the server anyway. | |
externalMessengerChannelId | string Id to the external messenger channel the conversation should be linked to. If this property is null the conversation is an Unblu conversation and not linked to a messenger channel. |
sourceId | string Custom id to identify the source of the conversation. Typically this is used in connection to an external messenger to create a link to the external conversation. |
endReason | string (EConversationEndReason) Enum: "ENDED_BY_PARTICIPANT" "MANDATORY_PARTICIPANT_GONE" "EXTERNAL_CHANNEL_CLOSED" "SOLVED_BY_BOT" "OTHER" enum-descriptions: ["ENDED_BY_PARTICIPANT","MANDATORY_PARTICIPANT_GONE","EXTERNAL_CHANNEL_CLOSED","SOLVED_BY_BOT","OTHER"] Closing reason of a conversation |
initialEngagementUrl | string The URL where the conversation was originated. Conversations originated by a visitor where Unblu was integrated in the customers website will have a value. e.g. conversations initiated from the mobile SDK won't have a initial engagement URL. |
object expand-query-key: configuration type: Map The entity's configuration properties. Only contains values when the 'expand' query parameter is used with the value 'configuration'. | |
object expand-query-key: text type: Map The entity's text properties. Only contains values when the 'expand' query parameter is used with the value 'text'. | |
object expand-query-key: metadata type: Map The entity's metadata properties. Only contains values when the 'expand' query parameter is used with the value 'metadata'. |
{- "$_type": "ConversationData",
- "creationTimestamp": 0,
- "endTimestamp": 0,
- "id": "string",
- "accountId": "string",
- "topic": "string",
- "recipient": {
- "$_type": "AccountData",
- "id": "string",
- "displayName": "string",
- "avatar": "string"
}, - "participants": [
- {
- "$_type": "ParticipantData",
- "state": "CREATED",
- "personId": "string",
- "connectedViaExternalMessenger": true,
- "hidden": true,
- "conversationStarred": true
}
], - "assigneePersonId": "string",
- "contextPersonId": "string",
- "state": "CREATED",
- "initialEngagementType": "CHAT_REQUEST",
- "locale": "string",
- "tokboxSessionId": "string",
- "visitorData": "string",
- "conversationTemplateId": "string",
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
], - "externalMessengerChannelId": "string",
- "sourceId": "string",
- "endReason": "ENDED_BY_PARTICIPANT",
- "initialEngagementUrl": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
New conversation created
{- "$_type": "ConversationData",
- "creationTimestamp": 1546300800000,
- "endTimestamp": null,
- "id": "AcviDb210C5BoFd6e_79oan",
- "accountId": "A7d9E_0-c3cC4aoFDb85t6n",
- "topic": null,
- "recipient": {
- "$_type": "AccountData",
- "id": "A7d9E_0-c3cC4aoFDb85t6n",
- "displayName": "Main Account",
- "avatar": null
}, - "participants": [
- {
- "$_type": "ParticipantData",
- "state": "ACTIVE",
- "personId": "nta30CBa-6d1a89cE57Db_F",
- "connectedViaExternalMessenger": false,
- "hidden": false,
- "conversationStarred": false
}
], - "assigneePersonId": null,
- "contextPersonId": "nta30CBa-6d1a89cE57Db_F",
- "state": "QUEUED",
- "initialEngagementType": "CHAT_REQUEST",
- "locale": "en",
- "tokboxSessionId": null,
- "visitorData": "test-visitorData-1234",
- "conversationTemplateId": "ab32em6Be-5le_48rE1F9Ad",
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "OPEN_IN_VISITOR_DESK",
- "url": "..."
}, - {
- "$_type": "ConversationLink",
- "type": "OPEN_IN_AGENT_DESK",
- "url": "..."
}, - {
- "$_type": "ConversationLink",
- "type": "OPEN_IN_AGENT_SINGLE_VIEW",
- "url": "..."
}
], - "externalMessengerChannelId": null,
- "sourceId": null,
- "endReason": null,
- "initialEngagementUrl": null,
- "configuration": null,
- "text": null,
- "metadata": null
}
Deletes the conversation for the given id
id | string The id of the conversation which should be deleted |
{- "$_type": "Error",
- "statusCode": 0,
- "statusDescription": "string",
- "errorMessage": "string"
}
End a conversation.
conversationId required | string the conversation that is updated |
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
reason | string (EConversationEndReason) Enum: "ENDED_BY_PARTICIPANT" "MANDATORY_PARTICIPANT_GONE" "EXTERNAL_CHANNEL_CLOSED" "SOLVED_BY_BOT" "OTHER" enum-descriptions: ["ENDED_BY_PARTICIPANT","MANDATORY_PARTICIPANT_GONE","EXTERNAL_CHANNEL_CLOSED","SOLVED_BY_BOT","OTHER"] Closing reason of a conversation |
comment | string |
End a conversation
{- "reason": "OTHER",
- "comment": "Some comment"
}
{- "$_type": "ConversationData",
- "creationTimestamp": 0,
- "endTimestamp": 0,
- "id": "string",
- "accountId": "string",
- "topic": "string",
- "recipient": {
- "$_type": "AccountData",
- "id": "string",
- "displayName": "string",
- "avatar": "string"
}, - "participants": [
- {
- "$_type": "ParticipantData",
- "state": "CREATED",
- "personId": "string",
- "connectedViaExternalMessenger": true,
- "hidden": true,
- "conversationStarred": true
}
], - "assigneePersonId": "string",
- "contextPersonId": "string",
- "state": "CREATED",
- "initialEngagementType": "CHAT_REQUEST",
- "locale": "string",
- "tokboxSessionId": "string",
- "visitorData": "string",
- "conversationTemplateId": "string",
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
], - "externalMessengerChannelId": "string",
- "sourceId": "string",
- "endReason": "ENDED_BY_PARTICIPANT",
- "initialEngagementUrl": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
Returns the conversation for the given source and channel id
sourceId | string The sourceId with which the conversation was created |
externalMessengerChannelId | string The messenger channel id to which the conversation is connected. Can be null for internal conversations. |
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
{- "$_type": "ConversationData",
- "creationTimestamp": 0,
- "endTimestamp": 0,
- "id": "string",
- "accountId": "string",
- "topic": "string",
- "recipient": {
- "$_type": "AccountData",
- "id": "string",
- "displayName": "string",
- "avatar": "string"
}, - "participants": [
- {
- "$_type": "ParticipantData",
- "state": "CREATED",
- "personId": "string",
- "connectedViaExternalMessenger": true,
- "hidden": true,
- "conversationStarred": true
}
], - "assigneePersonId": "string",
- "contextPersonId": "string",
- "state": "CREATED",
- "initialEngagementType": "CHAT_REQUEST",
- "locale": "string",
- "tokboxSessionId": "string",
- "visitorData": "string",
- "conversationTemplateId": "string",
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
], - "externalMessengerChannelId": "string",
- "sourceId": "string",
- "endReason": "ENDED_BY_PARTICIPANT",
- "initialEngagementUrl": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
Returns a list of all files that have been shared/sent within the specified conversation.
conversationId required | string the id of conversation, for which the file list should be retrieved |
[- {
- "$_type": "ConversationFileData",
- "conversationId": "string",
- "ownerPersonId": "string",
- "name": "string",
- "mimeType": "string",
- "source": "string",
- "fileStoreId": "string",
- "totalSize": 0,
- "downloadLink": "string",
- "creationTimestamp": 0
}
]
Offboard a participant from a conversation.
conversationId required | string the conversation that is updated |
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
personId | string |
reason | string (EConversationLeftReason) Enum: "FORWARDED" "PARTICIPANT_LEFT" "REMOVED_AFTER_TIMEOUT" "ONBOARDING_DECLINED" "ONBOARDING_IDLE_TIMEOUT" "ONBOARDING_TIMEOUT" "USER_CHANGED" "KICKED" "CONVERSATION_UNASSIGNED" "CONVERSATION_REQUEUED" "OTHER" enum-descriptions: ["FORWARDED","PARTICIPANT_LEFT","REMOVED_AFTER_TIMEOUT","ONBOARDING_DECLINED","ONBOARDING_IDLE_TIMEOUT","ONBOARDING_TIMEOUT","USER_CHANGED","KICKED","CONVERSATION_UNASSIGNED","CONVERSATION_REQUEUED","OTHER"] Participation left reason of a conversation |
comment | string |
Offboard a participant
{- "personId": "nta30CBa-6d1a89cE57Db_F",
- "reason": "OTHER",
- "comment": "Some other important reason"
}
{- "$_type": "ConversationData",
- "creationTimestamp": 0,
- "endTimestamp": 0,
- "id": "string",
- "accountId": "string",
- "topic": "string",
- "recipient": {
- "$_type": "AccountData",
- "id": "string",
- "displayName": "string",
- "avatar": "string"
}, - "participants": [
- {
- "$_type": "ParticipantData",
- "state": "CREATED",
- "personId": "string",
- "connectedViaExternalMessenger": true,
- "hidden": true,
- "conversationStarred": true
}
], - "assigneePersonId": "string",
- "contextPersonId": "string",
- "state": "CREATED",
- "initialEngagementType": "CHAT_REQUEST",
- "locale": "string",
- "tokboxSessionId": "string",
- "visitorData": "string",
- "conversationTemplateId": "string",
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
], - "externalMessengerChannelId": "string",
- "sourceId": "string",
- "endReason": "ENDED_BY_PARTICIPANT",
- "initialEngagementUrl": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
Returns the conversation for the given id
id | string Id of the conversation which should be returned |
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
{- "$_type": "ConversationData",
- "creationTimestamp": 0,
- "endTimestamp": 0,
- "id": "string",
- "accountId": "string",
- "topic": "string",
- "recipient": {
- "$_type": "AccountData",
- "id": "string",
- "displayName": "string",
- "avatar": "string"
}, - "participants": [
- {
- "$_type": "ParticipantData",
- "state": "CREATED",
- "personId": "string",
- "connectedViaExternalMessenger": true,
- "hidden": true,
- "conversationStarred": true
}
], - "assigneePersonId": "string",
- "contextPersonId": "string",
- "state": "CREATED",
- "initialEngagementType": "CHAT_REQUEST",
- "locale": "string",
- "tokboxSessionId": "string",
- "visitorData": "string",
- "conversationTemplateId": "string",
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
], - "externalMessengerChannelId": "string",
- "sourceId": "string",
- "endReason": "ENDED_BY_PARTICIPANT",
- "initialEngagementUrl": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
Search for conversations in the current account
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
$_type | string Default: "ConversationQuery" Value: "ConversationQuery" |
Array of any (ConversationSearchFilter) [ items ] List of filters to narrow the search of entities | |
Array of objects (ConversationOrderBy) [ items ] List of criteria to order the search result list | |
offset | integer <int32> Offset position in the result set to start pagination |
limit | integer <int32> Maximal amount of items returned |
{- "$_type": "ConversationQuery",
- "searchFilters": [
- {
- "$_type": "ParticipantPersonIdConversationSearchFilter",
- "field": "CREATION_TIMESTAMP",
- "operator": {
- "$_type": "AllOfIdListOperator",
- "type": "ALL_OF",
- "values": [
- "string"
]
}
}
], - "orderBy": [
- {
- "$_type": "ConversationOrderBy",
- "field": "CREATION_TIMESTAMP",
- "order": "ASCENDING"
}
], - "offset": 0,
- "limit": 0
}
{- "$_type": "ConversationResult",
- "hasMoreItems": true,
- "nextOffset": 0,
- "items": [
- {
- "$_type": "ConversationData",
- "creationTimestamp": 0,
- "endTimestamp": 0,
- "id": "string",
- "accountId": "string",
- "topic": "string",
- "recipient": {
- "$_type": "AccountData",
- "id": "string",
- "displayName": "string",
- "avatar": "string"
}, - "participants": [
- {
- "$_type": "ParticipantData",
- "state": "CREATED",
- "personId": "string",
- "connectedViaExternalMessenger": true,
- "hidden": true,
- "conversationStarred": true
}
], - "assigneePersonId": "string",
- "contextPersonId": "string",
- "state": "CREATED",
- "initialEngagementType": "CHAT_REQUEST",
- "locale": "string",
- "tokboxSessionId": "string",
- "visitorData": "string",
- "conversationTemplateId": "string",
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
], - "externalMessengerChannelId": "string",
- "sourceId": "string",
- "endReason": "ENDED_BY_PARTICIPANT",
- "initialEngagementUrl": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
]
}
Set an agent as assignee to a conversation.
Note: The person has to have an active participation in the conversation
conversationId required | string the conversation that is updated |
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
personId | string |
Set the assigned agent
{- "personId": "nta30CBa-6d1a89cE57Db_F"
}
{- "$_type": "ConversationData",
- "creationTimestamp": 0,
- "endTimestamp": 0,
- "id": "string",
- "accountId": "string",
- "topic": "string",
- "recipient": {
- "$_type": "AccountData",
- "id": "string",
- "displayName": "string",
- "avatar": "string"
}, - "participants": [
- {
- "$_type": "ParticipantData",
- "state": "CREATED",
- "personId": "string",
- "connectedViaExternalMessenger": true,
- "hidden": true,
- "conversationStarred": true
}
], - "assigneePersonId": "string",
- "contextPersonId": "string",
- "state": "CREATED",
- "initialEngagementType": "CHAT_REQUEST",
- "locale": "string",
- "tokboxSessionId": "string",
- "visitorData": "string",
- "conversationTemplateId": "string",
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
], - "externalMessengerChannelId": "string",
- "sourceId": "string",
- "endReason": "ENDED_BY_PARTICIPANT",
- "initialEngagementUrl": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
Set a visitor as context person of a conversation.
Note: The person has to have an active participation in the conversation
conversationId required | string the conversation that is updated |
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
personId | string |
Set the primary visitor
{- "personId": "nta30CBa-6d1a89cE57Db_F"
}
{- "$_type": "ConversationData",
- "creationTimestamp": 0,
- "endTimestamp": 0,
- "id": "string",
- "accountId": "string",
- "topic": "string",
- "recipient": {
- "$_type": "AccountData",
- "id": "string",
- "displayName": "string",
- "avatar": "string"
}, - "participants": [
- {
- "$_type": "ParticipantData",
- "state": "CREATED",
- "personId": "string",
- "connectedViaExternalMessenger": true,
- "hidden": true,
- "conversationStarred": true
}
], - "assigneePersonId": "string",
- "contextPersonId": "string",
- "state": "CREATED",
- "initialEngagementType": "CHAT_REQUEST",
- "locale": "string",
- "tokboxSessionId": "string",
- "visitorData": "string",
- "conversationTemplateId": "string",
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
], - "externalMessengerChannelId": "string",
- "sourceId": "string",
- "endReason": "ENDED_BY_PARTICIPANT",
- "initialEngagementUrl": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
Set the the locale of the conversation language (as BCP 47 language tag form including region if available).
conversationId required | string the conversation that is updated |
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
locale | string the new locale |
Set the conversation locale to german
{- "locale": "de"
}
{- "$_type": "ConversationData",
- "creationTimestamp": 0,
- "endTimestamp": 0,
- "id": "string",
- "accountId": "string",
- "topic": "string",
- "recipient": {
- "$_type": "AccountData",
- "id": "string",
- "displayName": "string",
- "avatar": "string"
}, - "participants": [
- {
- "$_type": "ParticipantData",
- "state": "CREATED",
- "personId": "string",
- "connectedViaExternalMessenger": true,
- "hidden": true,
- "conversationStarred": true
}
], - "assigneePersonId": "string",
- "contextPersonId": "string",
- "state": "CREATED",
- "initialEngagementType": "CHAT_REQUEST",
- "locale": "string",
- "tokboxSessionId": "string",
- "visitorData": "string",
- "conversationTemplateId": "string",
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
], - "externalMessengerChannelId": "string",
- "sourceId": "string",
- "endReason": "ENDED_BY_PARTICIPANT",
- "initialEngagementUrl": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
Set a person, named area, team or account as the recipient of a conversation.
conversationId required | string the conversation that is updated |
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
$_type | string Default: "AccountData" AccountData TeamData PersonData NamedAreaData AccountData |
id | string Unique id of the account. |
displayName | string Display-Name of the account |
string or Avatar (object) expand-query-key: avatar type: ExpandableField Avatar of the account: id that can be expanded. |
{- "$_type": "AccountData",
- "id": "string",
- "displayName": "string",
- "avatar": "string"
}
{- "$_type": "ConversationData",
- "creationTimestamp": 0,
- "endTimestamp": 0,
- "id": "string",
- "accountId": "string",
- "topic": "string",
- "recipient": {
- "$_type": "AccountData",
- "id": "string",
- "displayName": "string",
- "avatar": "string"
}, - "participants": [
- {
- "$_type": "ParticipantData",
- "state": "CREATED",
- "personId": "string",
- "connectedViaExternalMessenger": true,
- "hidden": true,
- "conversationStarred": true
}
], - "assigneePersonId": "string",
- "contextPersonId": "string",
- "state": "CREATED",
- "initialEngagementType": "CHAT_REQUEST",
- "locale": "string",
- "tokboxSessionId": "string",
- "visitorData": "string",
- "conversationTemplateId": "string",
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
], - "externalMessengerChannelId": "string",
- "sourceId": "string",
- "endReason": "ENDED_BY_PARTICIPANT",
- "initialEngagementUrl": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
Set the starred status of a conversation for a particular person
conversationId required | string the conversation to be starred/unstarred |
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
personId | string the person for whom the starred status will be set |
starred | boolean the starred status to b set |
{- "personId": "string",
- "starred": true
}
{- "$_type": "ConversationData",
- "creationTimestamp": 0,
- "endTimestamp": 0,
- "id": "string",
- "accountId": "string",
- "topic": "string",
- "recipient": {
- "$_type": "AccountData",
- "id": "string",
- "displayName": "string",
- "avatar": "string"
}, - "participants": [
- {
- "$_type": "ParticipantData",
- "state": "CREATED",
- "personId": "string",
- "connectedViaExternalMessenger": true,
- "hidden": true,
- "conversationStarred": true
}
], - "assigneePersonId": "string",
- "contextPersonId": "string",
- "state": "CREATED",
- "initialEngagementType": "CHAT_REQUEST",
- "locale": "string",
- "tokboxSessionId": "string",
- "visitorData": "string",
- "conversationTemplateId": "string",
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
], - "externalMessengerChannelId": "string",
- "sourceId": "string",
- "endReason": "ENDED_BY_PARTICIPANT",
- "initialEngagementUrl": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
Set custom visitor data.
conversationId required | string the conversation where the custom data should be added |
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
the custom visitor data
$_type | string Default: "ConversationsSetVisitorDataBody" Value: "ConversationsSetVisitorDataBody" |
visitorData | string Custom visitor data in any format. |
{- "$_type": "ConversationsSetVisitorDataBody",
- "visitorData": "string"
}
{- "$_type": "ConversationData",
- "creationTimestamp": 0,
- "endTimestamp": 0,
- "id": "string",
- "accountId": "string",
- "topic": "string",
- "recipient": {
- "$_type": "AccountData",
- "id": "string",
- "displayName": "string",
- "avatar": "string"
}, - "participants": [
- {
- "$_type": "ParticipantData",
- "state": "CREATED",
- "personId": "string",
- "connectedViaExternalMessenger": true,
- "hidden": true,
- "conversationStarred": true
}
], - "assigneePersonId": "string",
- "contextPersonId": "string",
- "state": "CREATED",
- "initialEngagementType": "CHAT_REQUEST",
- "locale": "string",
- "tokboxSessionId": "string",
- "visitorData": "string",
- "conversationTemplateId": "string",
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
], - "externalMessengerChannelId": "string",
- "sourceId": "string",
- "endReason": "ENDED_BY_PARTICIPANT",
- "initialEngagementUrl": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
Update the configuration map for a specific conversation
conversationId required | string the conversation that is updated |
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
the key-value map of settings that will be updated. The source for this map has to be the configuration
attribute when you read the conversation using configuration
in the expand
query parameter.
property name* | string |
Map to update the translations
{- "$_version": "d41d8cd98f00b204e9800998ecf8427e",
- "com.unblu.conversation.feature.callEnabled": "true",
- "com.unblu.conversation.feature.textChatEnabled": "false",
- "com.unblu.conversation.lifecycle.autoEndOnLeave": "SECONDARY_AGENT"
}
Conversation after the settings update (loaded with expanded configuration)
{- "$_type": "ConversationData",
- "creationTimestamp": 1546300800000,
- "endTimestamp": null,
- "id": "AcviDb210C5BoFd6e_79oan",
- "accountId": "A7d9E_0-c3cC4aoFDb85t6n",
- "topic": null,
- "recipient": {
- "$_type": "AccountData",
- "id": "A7d9E_0-c3cC4aoFDb85t6n",
- "displayName": "Main Account",
- "avatar": null
}, - "participants": [
- {
- "$_type": "ParticipantData",
- "state": "ACTIVE",
- "personId": "nta30CBa-6d1a89cE57Db_F",
- "connectedViaExternalMessenger": false,
- "hidden": false,
- "conversationStarred": false
}
], - "assigneePersonId": null,
- "contextPersonId": "nta30CBa-6d1a89cE57Db_F",
- "state": "QUEUED",
- "initialEngagementType": "CHAT_REQUEST",
- "locale": "en",
- "tokboxSessionId": null,
- "visitorData": null,
- "conversationTemplateId": "ab32em6Be-5le_48rE1F9Ad",
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "OPEN_IN_VISITOR_DESK",
- "url": "..."
}, - {
- "$_type": "ConversationLink",
- "type": "OPEN_IN_AGENT_DESK",
- "url": "..."
}, - {
- "$_type": "ConversationLink",
- "type": "OPEN_IN_AGENT_SINGLE_VIEW",
- "url": "..."
}
], - "externalMessengerChannelId": null,
- "sourceId": null,
- "endReason": null,
- "initialEngagementUrl": null,
- "configuration": {
- "$_version": "071ca160e0b7bd9b311060b160edb783",
- "com.unblu.conversation.feature.callEnabled": "true",
- "com.unblu.conversation.feature.textChatEnabled": "false",
- "com.unblu.conversation.lifecycle.autoEndOnLeave": "SECONDARY_AGENT"
}, - "text": null,
- "metadata": null
}
Update the metadata map for a specific conversation
conversationId required | string the conversation that is updated |
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
the key-value map of metadata that will be updated. The source for this map has to be the metadata
attribute when you read the conversation using metadata
in the expand
query parameter.
property name* | string |
Map to update the medata
{- "$_version": "d41d8cd98f00b204e9800998ecf8427e",
- "foo": "bar",
- "lorem": "ipsum"
}
Conversation after the metadata update (loaded with expanded metadata)
{- "$_type": "ConversationData",
- "creationTimestamp": 1546300800000,
- "endTimestamp": null,
- "id": "AcviDb210C5BoFd6e_79oan",
- "accountId": "A7d9E_0-c3cC4aoFDb85t6n",
- "topic": null,
- "recipient": {
- "$_type": "AccountData",
- "id": "A7d9E_0-c3cC4aoFDb85t6n",
- "displayName": "Main Account",
- "avatar": null
}, - "participants": [
- {
- "$_type": "ParticipantData",
- "state": "ACTIVE",
- "personId": "nta30CBa-6d1a89cE57Db_F",
- "connectedViaExternalMessenger": false,
- "hidden": false,
- "conversationStarred": false
}
], - "assigneePersonId": null,
- "contextPersonId": "nta30CBa-6d1a89cE57Db_F",
- "state": "QUEUED",
- "initialEngagementType": "CHAT_REQUEST",
- "locale": "en",
- "tokboxSessionId": null,
- "visitorData": null,
- "conversationTemplateId": "ab32em6Be-5le_48rE1F9Ad",
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "OPEN_IN_VISITOR_DESK",
- "url": "..."
}, - {
- "$_type": "ConversationLink",
- "type": "OPEN_IN_AGENT_DESK",
- "url": "..."
}, - {
- "$_type": "ConversationLink",
- "type": "OPEN_IN_AGENT_SINGLE_VIEW",
- "url": "..."
}
], - "externalMessengerChannelId": null,
- "sourceId": null,
- "endReason": null,
- "initialEngagementUrl": null,
- "configuration": null,
- "text": null,
- "metadata": {
- "$_version": "cd8762c9c0e0525d8e49e173276420ff",
- "foo": "bar",
- "lorem": "ipsum"
}
}
Update the text map for a specific conversation
conversationId required | string the conversation that is updated |
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
the key-value map of translations that will be updated. The source for this map has to be the text
attribute when you read the conversation using text
in the expand
query parameter.
object |
Map to update the translations
{- "$_version": {
- "$_version": "d41d8cd98f00b204e9800998ecf8427e"
}, - "com.unblu.conversation.concierge.onboardingDoneMessage": {
- "en": "Thank you, see you soon."
}, - "com.unblu.conversation.concierge.onboardingWelcomeMessage": {
- "en": "Hello, I am the concierge.",
- "fr": "Bonjour je suis le concierge."
}
}
Conversation after the translations update (loaded with expanded text)
{- "$_type": "ConversationData",
- "creationTimestamp": 1546300800000,
- "endTimestamp": null,
- "id": "AcviDb210C5BoFd6e_79oan",
- "accountId": "A7d9E_0-c3cC4aoFDb85t6n",
- "topic": null,
- "recipient": {
- "$_type": "AccountData",
- "id": "A7d9E_0-c3cC4aoFDb85t6n",
- "displayName": "Main Account",
- "avatar": null
}, - "participants": [
- {
- "$_type": "ParticipantData",
- "state": "ACTIVE",
- "personId": "nta30CBa-6d1a89cE57Db_F",
- "connectedViaExternalMessenger": false,
- "hidden": false,
- "conversationStarred": false
}
], - "assigneePersonId": null,
- "contextPersonId": "nta30CBa-6d1a89cE57Db_F",
- "state": "QUEUED",
- "initialEngagementType": "CHAT_REQUEST",
- "locale": "en",
- "tokboxSessionId": null,
- "visitorData": null,
- "conversationTemplateId": "ab32em6Be-5le_48rE1F9Ad",
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "OPEN_IN_VISITOR_DESK",
- "url": "..."
}, - {
- "$_type": "ConversationLink",
- "type": "OPEN_IN_AGENT_DESK",
- "url": "..."
}, - {
- "$_type": "ConversationLink",
- "type": "OPEN_IN_AGENT_SINGLE_VIEW",
- "url": "..."
}
], - "externalMessengerChannelId": null,
- "sourceId": null,
- "endReason": null,
- "initialEngagementUrl": null,
- "configuration": null,
- "text": {
- "$_version": {
- "$_version": "e2d4feca277925dcb73d00c158e7e36e"
}, - "com.unblu.conversation.concierge.onboardingDoneMessage": {
- "en": "Thank you, see you soon."
}, - "com.unblu.conversation.concierge.onboardingWelcomeMessage": {
- "en": "Hello, I am the concierge.",
- "fr": "Bonjour je suis le concierge."
}
}, - "metadata": null
}
Service to manage the domains of the account. A domain needs to be defined to use unblu on it.
Creates the given entity in the system. The id of the entity can not be set for create operation, a new one is generated.
The entity to create
$_type | string Default: "Domain" Value: "Domain" |
id | string Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway. |
creationTimestamp | integer <int64> Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
modificationTimestamp | integer <int64> Timestamp of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
version | integer <int64> Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted. |
accountId | string Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
domainName | string The name/adress of the domain. It should normally contain a protocol (e.g. http:// or https://) and the url of the domain (e.g. www.unblu.com). Maximum of 250 characters. Can not be omitted. 250 characters. |
{- "$_type": "Domain",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "domainName": "string"
}
{- "$_type": "Domain",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "domainName": "string"
}
Deletes the entity for the given id
id | string The id of the entity which should be deleted |
{- "$_type": "Error",
- "statusCode": 0,
- "statusDescription": "string",
- "errorMessage": "string"
}
Returns the entity for the given id
id | string Id of the entity which should be returned |
{- "$_type": "Domain",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "domainName": "string"
}
Gets a list of entities for the given id's
The id's for which the entities should be fetched
[- "string"
]
[- {
- "$_type": "Domain",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "domainName": "string"
}
]
Search for domains in the current account
$_type | string Default: "DomainQuery" Value: "DomainQuery" |
Array of any (DomainSearchFilter) [ items ] List of filters to narrow the search of entities | |
Array of objects (DomainOrderBy) [ items ] List of criteria to order the search result list | |
offset | integer <int32> Offset position in the result set to start pagination |
limit | integer <int32> Maximal amount of items returned |
{- "$_type": "DomainQuery",
- "searchFilters": [
- {
- "$_type": "CreationTimestampDomainSearchFilter",
- "field": "DOMAIN_NAME",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
], - "orderBy": [
- {
- "$_type": "DomainOrderBy",
- "field": "ID",
- "order": "ASCENDING"
}
], - "offset": 0,
- "limit": 0
}
{- "$_type": "DomainResult",
- "hasMoreItems": true,
- "nextOffset": 0,
- "items": [
- {
- "$_type": "Domain",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "domainName": "string"
}
]
}
Updates the entity in the system with the given entity.
The entity to update
$_type | string Default: "Domain" Value: "Domain" |
id | string Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway. |
creationTimestamp | integer <int64> Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
modificationTimestamp | integer <int64> Timestamp of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
version | integer <int64> Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted. |
accountId | string Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
domainName | string The name/adress of the domain. It should normally contain a protocol (e.g. http:// or https://) and the url of the domain (e.g. www.unblu.com). Maximum of 250 characters. Can not be omitted. 250 characters. |
{- "$_type": "Domain",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "domainName": "string"
}
{- "$_type": "Domain",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "domainName": "string"
}
Manages all types of ExternalMessengerChannel
and can be used to send messages from external messengers into a collaboration server conversation.
Creates a new external messenger channel
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
The channel which should be created
$_type | string Default: "CustomExternalMessengerChannel" CustomExternalMessengerChannel CustomExternalMessengerChannel |
id | string Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway. |
creationTimestamp | integer <int64> Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
modificationTimestamp | integer <int64> Timestamp of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
version | integer <int64> Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted. |
accountId | string Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
name | string Name of the channel. Needs to be unique in the account. |
description | string Optional description of the channel |
string or Avatar (object) expand-query-key: channelIcon type: ExpandableField Channel icon of the entity: id that can be expanded. | |
sourceId | string Custom identifier to find the source of the channel. |
type | string (EExternalMessengerChannelType) Enum: "CUSTOM" "WHATS_APP" "FACEBOOK" enum-descriptions: ["CUSTOM: Custom channel which is connected via rest and webhooks","WHATS_APP: WhatsApp channel which is managed by the collaboration server","FACEBOOK: Facebook channel which is managed by the collaboration server"] The type of the external messenger channel |
webhookEndpoint | string The endpoint url of the webhook registration. To this url the requests for the webhook events are done. Maximum length of 4000 characters. Can not be omitted. |
webhookSecret | string A secret which is send with each webhook event. Maximum length of 4000 characters. Can be omitted. |
webhookStatus | string (ERegistrationStatus) Enum: "ACTIVE" "INACTIVE" "INACTIVE_UNAVAILABLE" enum-descriptions: ["ACTIVE: Registration is active","INACTIVE: Registration is not active","INACTIVE_UNAVAILABLE: Registration is not active, because it is unavailable"] Possible Webhook Registration Status |
messageStateHandledExternally | boolean Defines if the delivered/read state of messages is handled externally or by the collaboration server. |
object expand-query-key: metadata type: Map The entity's metadata properties. Only contains values when the 'expand' query parameter is used with the value 'metadata'. |
Create a new external messenger channel
{- "$_type": "CustomExternalMessengerChannel",
- "id": null,
- "creationTimestamp": null,
- "modificationTimestamp": null,
- "version": null,
- "accountId": null,
- "name": "custom name",
- "description": "custom description",
- "channelIcon": null,
- "sourceId": "custom-sourceId",
- "type": "CUSTOM",
- "webhookSecret": "custom-secret",
- "webhookStatus": "ACTIVE",
- "messageStateHandledExternally": null,
- "metadata": null
}
New external messenger channel
{- "$_type": "CustomExternalMessengerChannel",
- "id": "cne9hsne4rgxa2es6MenC8d",
- "creationTimestamp": 1546300800000,
- "modificationTimestamp": 1548979200000,
- "version": 1,
- "accountId": "A7d9E_0-c3cC4aoFDb85t6n",
- "name": "custom name",
- "description": "custom description",
- "channelIcon": "custom",
- "sourceId": "custom-sourceId",
- "type": "CUSTOM",
- "webhookSecret": "custom-secret",
- "webhookStatus": "ACTIVE",
- "messageStateHandledExternally": false,
- "metadata": null
}
{- "$_type": "ExternalMessengerMessageStateEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "messageId": "string",
- "state": "DELIVERED",
- "sourceId": "string",
- "externalMessengerChannelId": "string",
- "conversationId": "string"
}
Deletes an external messenger channel. All conversations connected to this channel will be ended as soon as they activated again
id | string The ID of the channel which should be deleted |
{- "$_type": "Error",
- "statusCode": 0,
- "statusDescription": "string",
- "errorMessage": "string"
}
Returns the channel for the given name
name | string The name of the external messenger channel |
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
External messenger channel
{- "$_type": "CustomExternalMessengerChannel",
- "id": "cne9hsne4rgxa2es6MenC8d",
- "creationTimestamp": 1546300800000,
- "modificationTimestamp": 1548979200000,
- "version": 1,
- "accountId": "A7d9E_0-c3cC4aoFDb85t6n",
- "name": "123 name",
- "description": "123 description",
- "channelIcon": "custom",
- "sourceId": "123-sourceId",
- "type": "CUSTOM",
- "webhookSecret": "123-secret",
- "webhookStatus": "ACTIVE",
- "messageStateHandledExternally": false,
- "metadata": null
}
Marks a message as delivered to the given person. If no person is specified, it will be marked as delivered to all persons which are connected via the external messenger.
If the message is also read, use directly the end point messageRead
as it will mark it as delivered too.
conversationId | string The id of the conversation |
externalMessengerChannelId | string The id of the custom external messenger channel |
messageId | string The id of the message from the conversation, which should be marked as delivered |
personId | string The id of the person who received the message. If null, it will be assumed that the message has been delivered to all persons which are connected via the external messenger. |
Mark a message as delivered
{- "conversationId": "AcviDb210C5BoFd6e_79oan",
- "externalMessengerChannelId": "cne9hsne4rgxa2es6MenC8d",
- "messageId": "mGesYagET_2GipaDGinA9A",
- "personId": "nta30CBa-6d1a89cE57Db_F"
}
{- "$_type": "Error",
- "statusCode": 0,
- "statusDescription": "string",
- "errorMessage": "string"
}
Marks a message as read by the given person. If no person is specified, it will be marked as read by all persons which are connected via the external messenger.
This will also mark the message as delivered, if it was not already.
conversationId | string The id of the conversation |
externalMessengerChannelId | string The id of the custom external messenger channel |
messageId | string The id of the message from the conversation, which should be marked as read |
personId | string The id of the person who read the message. If null, it will be assumed that the message has been read by all persons which are connected via the external messenger. |
Mark a message as delivered
{- "conversationId": "AcviDb210C5BoFd6e_79oan",
- "externalMessengerChannelId": "cne9hsne4rgxa2es6MenC8d",
- "messageId": "mGesYagET_2GipaDGinA9A",
- "personId": "nta30CBa-6d1a89cE57Db_F"
}
{- "$_type": "Error",
- "statusCode": 0,
- "statusDescription": "string",
- "errorMessage": "string"
}
Indicates that the message could not be sent to the external messenger. There are the following fail state which can be set:
ESendFailState.RETRYABLE
: if a retry of sending in the future may solve the problem. (e.g. temporary connection failure). In this case the user will be provided with a UI to retry sending the messageESendFailState.TERMINAL
: if no amount of retries would solve the problem. (e.g. the underlying conversation no longer exists in the external messenger.)conversationId | string The id of the conversation |
externalMessengerChannelId | string The id of the custom external messenger channel |
messageId | string The id of the message from the conversation, which should be set to the failed state |
failedState | string (ESendFailState) Enum: "RETRYABLE" "TERMINAL" enum-descriptions: ["RETRYABLE: Message could not be sent, but it is not terminal and can be tried again","TERMINAL: Message could not be sent and it will not be possible to send it again"] The failed state of a message which was sent to an external messenger |
failureText | string A text which describes why a message could not be sent to the external messenger. This text will be displayed to the user in the UI of the message |
{- "conversationId": "string",
- "externalMessengerChannelId": "string",
- "messageId": "string",
- "failedState": "RETRYABLE",
- "failureText": "string"
}
{- "$_type": "Error",
- "statusCode": 0,
- "statusDescription": "string",
- "errorMessage": "string"
}
Indication that a message was successfully sent to the external messenger.
This will be visualized in the Unblu UI.
Note: This does not mean the message has been delivered to or read by the recipient. These states can be updated using themessageDelivered
and messageRead
services.
conversationId | string The id of the conversation |
externalMessengerChannelId | string The id of the custom external messenger channel |
messageId | string The id of the message from the conversation, which was successfully sent |
{- "conversationId": "string",
- "externalMessengerChannelId": "string",
- "messageId": "string"
}
{- "$_type": "Error",
- "statusCode": 0,
- "statusDescription": "string",
- "errorMessage": "string"
}
Emits a WebhookPingEvent
on the configured webhook for the custom channel.
externalMessengerChannelId | string The ID of an external messenger channel of type |
Send a ping event for the given External messenger channel
{- "externalMessengerChannelId": "cne9hsne4rgxa2es6MenC8d"
}
{- "$_type": "Error",
- "statusCode": 0,
- "statusDescription": "string",
- "errorMessage": "string"
}
Returns the channel for the given ID
id | string The ID of the external messenger channel |
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
External messenger channel
{- "$_type": "CustomExternalMessengerChannel",
- "id": "cne9hsne4rgxa2es6MenC8d",
- "creationTimestamp": 1546300800000,
- "modificationTimestamp": 1548979200000,
- "version": 1,
- "accountId": "A7d9E_0-c3cC4aoFDb85t6n",
- "name": "custom name",
- "description": "custom description",
- "channelIcon": "custom",
- "sourceId": "custom-sourceId",
- "type": "CUSTOM",
- "webhookSecret": "custom-secret",
- "webhookStatus": "ACTIVE",
- "messageStateHandledExternally": false,
- "metadata": null
}
Search for external messenger channels in the current account
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
$_type | string Default: "ExternalMessengerChannelQuery" Value: "ExternalMessengerChannelQuery" |
Array of any (ExternalMessengerChannelSearchFilter) [ items ] List of filters to narrow the search of entities | |
Array of objects (ExternalMessengerChannelOrderBy) [ items ] List of criteria to order the search result list | |
offset | integer <int32> Offset position in the result set to start pagination |
limit | integer <int32> Maximal amount of items returned |
{- "$_type": "ExternalMessengerChannelQuery",
- "searchFilters": [
- {
- "$_type": "CreationTimestampExternalMessengerChannelSearchFilter",
- "field": "NAME",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
], - "orderBy": [
- {
- "$_type": "ExternalMessengerChannelOrderBy",
- "field": "ID",
- "order": "ASCENDING"
}
], - "offset": 0,
- "limit": 0
}
{- "$_type": "ExternalMessengerChannelResult",
- "hasMoreItems": true,
- "nextOffset": 0,
- "items": [
- {
- "$_type": "CustomExternalMessengerChannel",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "name": "string",
- "description": "string",
- "channelIcon": "string",
- "sourceId": "string",
- "type": "CUSTOM",
- "webhookEndpoint": "string",
- "webhookSecret": "string",
- "webhookStatus": "ACTIVE",
- "messageStateHandledExternally": true,
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}
]
}
Send a message to a conversation. The corresponding conversation has to be connected to the same custom channel.
The message to send into the conversation.
$_type | string Default: "ExternalMessengerPostMessage" Value: "ExternalMessengerPostMessage" |
conversationId | string The id of the conversation to which this message belongs to |
externalMessengerChannelId | string The id of the external messenger channel this message belongs to |
senderPersonId | string ID of the person that sent the message. |
recipientPersonIds | Array of strings Person IDs of the recipients of the message. If it is null, all active participations are recipients |
sourceId | string An id identifying the source of the external message. Typically the id of the message in the other messaging system |
any (PostMessageData) Base class for all conversation messages send to the collaboration server. |
Send text message containing fallback text and quick replies to external messenger channel
{- "$_type": "ExternalMessengerPostMessage",
- "conversationId": "AcviDb210C5BoFd6e_79oan",
- "externalMessengerChannelId": "cne9hsne4rgxa2es6MenC8d",
- "senderPersonId": "nta30CBa-6d1a89cE57Db_F",
- "recipientPersonIds": null,
- "sourceId": "message-source",
- "messageData": {
- "$_type": "TextPostMessageData",
- "type": "TEXT",
- "fallbackText": "message from visitor fallback",
- "text": "message from visitor ",
- "textType": "SIMPLE_TEXT",
- "quickReplies": [
- {
- "$_type": "QuickReply",
- "text": "Thank you"
}, - {
- "$_type": "QuickReply",
- "text": "Is that all I can do for you?"
}
]
}
}
"string"
Updates an external messenger channel
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
The channel which should be updated
$_type | string Default: "CustomExternalMessengerChannel" CustomExternalMessengerChannel CustomExternalMessengerChannel |
id | string Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway. |
creationTimestamp | integer <int64> Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
modificationTimestamp | integer <int64> Timestamp of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
version | integer <int64> Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted. |
accountId | string Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
name | string Name of the channel. Needs to be unique in the account. |
description | string Optional description of the channel |
string or Avatar (object) expand-query-key: channelIcon type: ExpandableField Channel icon of the entity: id that can be expanded. | |
sourceId | string Custom identifier to find the source of the channel. |
type | string (EExternalMessengerChannelType) Enum: "CUSTOM" "WHATS_APP" "FACEBOOK" enum-descriptions: ["CUSTOM: Custom channel which is connected via rest and webhooks","WHATS_APP: WhatsApp channel which is managed by the collaboration server","FACEBOOK: Facebook channel which is managed by the collaboration server"] The type of the external messenger channel |
webhookEndpoint | string The endpoint url of the webhook registration. To this url the requests for the webhook events are done. Maximum length of 4000 characters. Can not be omitted. |
webhookSecret | string A secret which is send with each webhook event. Maximum length of 4000 characters. Can be omitted. |
webhookStatus | string (ERegistrationStatus) Enum: "ACTIVE" "INACTIVE" "INACTIVE_UNAVAILABLE" enum-descriptions: ["ACTIVE: Registration is active","INACTIVE: Registration is not active","INACTIVE_UNAVAILABLE: Registration is not active, because it is unavailable"] Possible Webhook Registration Status |
messageStateHandledExternally | boolean Defines if the delivered/read state of messages is handled externally or by the collaboration server. |
object expand-query-key: metadata type: Map The entity's metadata properties. Only contains values when the 'expand' query parameter is used with the value 'metadata'. |
Update a external messenger channel
{- "$_type": "CustomExternalMessengerChannel",
- "id": "cne9hsne4rgxa2es6MenC8d",
- "creationTimestamp": 1546300800000,
- "modificationTimestamp": 1548979200000,
- "version": 1,
- "accountId": "A7d9E_0-c3cC4aoFDb85t6n",
- "name": "Updated Name ",
- "description": "custom description",
- "channelIcon": "custom",
- "sourceId": "custom-sourceId",
- "type": "CUSTOM",
- "webhookSecret": "custom-secret",
- "webhookStatus": "ACTIVE",
- "messageStateHandledExternally": false,
- "metadata": null
}
Updated external messenger channel
{- "$_type": "CustomExternalMessengerChannel",
- "id": "cne9hsne4rgxa2es6MenC8d",
- "creationTimestamp": 1546300800000,
- "modificationTimestamp": 1548979200000,
- "version": 2,
- "accountId": "A7d9E_0-c3cC4aoFDb85t6n",
- "name": "Updated Name ",
- "description": "custom description",
- "channelIcon": "custom",
- "sourceId": "custom-sourceId",
- "type": "CUSTOM",
- "webhookSecret": "custom-secret",
- "webhookStatus": "ACTIVE",
- "messageStateHandledExternally": false,
- "metadata": null
}
With this service the global Unblu system can be managed.
For super-admin the Global object can be expanded to set configuration or translations.
Install a new license in the global server.
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
licenseContent
{- "$_type": "GlobalData",
- "serverIdentifier": "string",
- "currentLicense": {
- "$_type": "LicenseData",
- "state": "NO_LICENSE",
- "licenseId": "string",
- "expirationTimestamp": 0,
- "features": {
- "property1": { },
- "property2": { }
}
}, - "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
Returns the GlobalData object containing information about the system (license, settings).
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
{- "$_type": "GlobalData",
- "serverIdentifier": "string",
- "currentLicense": {
- "$_type": "LicenseData",
- "state": "NO_LICENSE",
- "licenseId": "string",
- "expirationTimestamp": 0,
- "features": {
- "property1": { },
- "property2": { }
}
}, - "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
Updates the GlobalData object. Since the properties of the Global object are read-only, this methods only make sense when used with the expand parameter.
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
$_type | string Default: "GlobalData" Value: "GlobalData" |
serverIdentifier | string A unique id identifying an Unblu installation. This is read only information it will be set by the server anyway. |
object (LicenseData) Entity representing the current installed license | |
object expand-query-key: configuration type: Map The entity's configuration properties. Only contains values when the 'expand' query parameter is used with the value 'configuration'. | |
object expand-query-key: text type: Map The entity's text properties. Only contains values when the 'expand' query parameter is used with the value 'text'. | |
object expand-query-key: metadata type: Map The entity's metadata properties. Only contains values when the 'expand' query parameter is used with the value 'metadata'. |
{- "$_type": "GlobalData",
- "serverIdentifier": "string",
- "currentLicense": {
- "$_type": "LicenseData",
- "state": "NO_LICENSE",
- "licenseId": "string",
- "expirationTimestamp": 0,
- "features": {
- "property1": { },
- "property2": { }
}
}, - "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
{- "$_type": "GlobalData",
- "serverIdentifier": "string",
- "currentLicense": {
- "$_type": "LicenseData",
- "state": "NO_LICENSE",
- "licenseId": "string",
- "expirationTimestamp": 0,
- "features": {
- "property1": { },
- "property2": { }
}
}, - "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
Forwards a conversation to an agent. The current assigned agent stays in the conversation until the invitation is accepted. Once the invited agent accepts the invitation, they join the conversation as the assigned agent, and the previous assigned agent is removed from the conversation.
If there is already a forwarding invitation for the conversation, that invitation is revoked.
If the conversation is in the queue, the assignment request invitation is revoked.
conversationId | string Conversation id. |
agentPersonId | string Person ID of the agent. |
comment | string Invitation comment that will be displayed to the invited agent. Optional. |
{- "conversationId": "string",
- "agentPersonId": "string",
- "comment": "string"
}
{- "$_type": "ConversationInvitationData",
- "accountId": "string",
- "invitationType": "CONVERSATION_REQUEST",
- "invitationState": "OPEN",
- "id": "string",
- "conversationId": "string",
- "token": "string",
- "createdTimestamp": 0,
- "creatorType": "WEB_API",
- "creatorPersonId": "string",
- "targetId": "string",
- "targetType": "ANONYMOUS",
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
], - "redeemingPersonId": "string",
- "comment": "string",
- "email": "string",
- "nickname": "string",
- "expirationTimestamp": 0
}
Forwards a conversation to a team. The current assigned agent remains in the conversation until the invitation is accepted. Once an agent of the invited team or its parent teams accepts the invitation, they join the conversation as its assigned agent, and the previous assigned agent is removed from the conversation.
If there is already a forwarding invitation for the conversation, that invitation is revoked.
If the conversation is in the queue, the assignment request invitation is revoked.
conversationId | string Conversation id. |
teamId | string Team id. |
comment | string Invitation comment. Optional. |
{- "conversationId": "string",
- "teamId": "string",
- "comment": "string"
}
{- "$_type": "ConversationInvitationData",
- "accountId": "string",
- "invitationType": "CONVERSATION_REQUEST",
- "invitationState": "OPEN",
- "id": "string",
- "conversationId": "string",
- "token": "string",
- "createdTimestamp": 0,
- "creatorType": "WEB_API",
- "creatorPersonId": "string",
- "targetId": "string",
- "targetType": "ANONYMOUS",
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
], - "redeemingPersonId": "string",
- "comment": "string",
- "email": "string",
- "nickname": "string",
- "expirationTimestamp": 0
}
Creates an invitation to the given conversation for an agent. If the agent accepts the invitation, they join the conversation as a secondary agent. If a conflicting invitation already exists, an error is returned.
conversationId | string Conversation id. |
agentPersonId | string Person ID of the invited agent. |
comment | string Invitation comment. Optional. |
{- "conversationId": "string",
- "agentPersonId": "string",
- "comment": "string"
}
{- "$_type": "ConversationInvitationData",
- "accountId": "string",
- "invitationType": "CONVERSATION_REQUEST",
- "invitationState": "OPEN",
- "id": "string",
- "conversationId": "string",
- "token": "string",
- "createdTimestamp": 0,
- "creatorType": "WEB_API",
- "creatorPersonId": "string",
- "targetId": "string",
- "targetType": "ANONYMOUS",
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
], - "redeemingPersonId": "string",
- "comment": "string",
- "email": "string",
- "nickname": "string",
- "expirationTimestamp": 0
}
Invites an authenticated visitor to join a conversation by email. Calling this method sends an email to the email address provided containing a link that opens the conversation in the Visitor Desk.
conversationId | string Conversation id. |
string Email address that will be applied to the visitor who accepts the invitation if they are anonymous and haven't provided an email address. Optional. | |
nickname | string Nickname that will be applied to the visitor who accepts the invitation if they are anonymous and don't already have a nickname set. Optional. |
{- "conversationId": "string",
- "email": "string",
- "nickname": "string"
}
{- "$_type": "ConversationInvitationData",
- "accountId": "string",
- "invitationType": "CONVERSATION_REQUEST",
- "invitationState": "OPEN",
- "id": "string",
- "conversationId": "string",
- "token": "string",
- "createdTimestamp": 0,
- "creatorType": "WEB_API",
- "creatorPersonId": "string",
- "targetId": "string",
- "targetType": "ANONYMOUS",
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
], - "redeemingPersonId": "string",
- "comment": "string",
- "email": "string",
- "nickname": "string",
- "expirationTimestamp": 0
}
Invites an authenticated visitor to a join conversation using a link. The returned invitation data contains a link of the type "ACCEPT_IN_VISITOR_DESK" which can be passed on to the invited visitor.
conversationId | string Conversation id. |
nickname | string Nickname that will be applied to the visitor who accepts the invitation if they are anonymous and don't already have a nickname set. Optional. |
{- "conversationId": "string",
- "nickname": "string"
}
{- "$_type": "ConversationInvitationData",
- "accountId": "string",
- "invitationType": "CONVERSATION_REQUEST",
- "invitationState": "OPEN",
- "id": "string",
- "conversationId": "string",
- "token": "string",
- "createdTimestamp": 0,
- "creatorType": "WEB_API",
- "creatorPersonId": "string",
- "targetId": "string",
- "targetType": "ANONYMOUS",
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
], - "redeemingPersonId": "string",
- "comment": "string",
- "email": "string",
- "nickname": "string",
- "expirationTimestamp": 0
}
Invites an authenticated visitor to join a conversation using a PIN. The PIN con be found in the "token" field of the returned invitation. It can be redeemed by entering it in the embedded or floating site integration UI.
conversationId | string Conversation id. |
nickname | string Nickname that will be applied to the visitor who accepts the invitation if they are anonymous and don't already have a nickname set. Optional. |
{- "conversationId": "string",
- "nickname": "string"
}
{- "$_type": "ConversationInvitationData",
- "accountId": "string",
- "invitationType": "CONVERSATION_REQUEST",
- "invitationState": "OPEN",
- "id": "string",
- "conversationId": "string",
- "token": "string",
- "createdTimestamp": 0,
- "creatorType": "WEB_API",
- "creatorPersonId": "string",
- "targetId": "string",
- "targetType": "ANONYMOUS",
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
], - "redeemingPersonId": "string",
- "comment": "string",
- "email": "string",
- "nickname": "string",
- "expirationTimestamp": 0
}
Creates an invitation for a team for the given conversation. The invitation can be redeemed once by any agent in either the invited team or one of its parent teams. The agent who redeeems the invitation joins the conversation as a secondary agent. If a conflicting invitation already exists, an error is returned.
conversationId | string Conversation id. |
teamId | string Team id. |
comment | string Invitation comment. Optional. |
{- "conversationId": "string",
- "teamId": "string",
- "comment": "string"
}
{- "$_type": "ConversationInvitationData",
- "accountId": "string",
- "invitationType": "CONVERSATION_REQUEST",
- "invitationState": "OPEN",
- "id": "string",
- "conversationId": "string",
- "token": "string",
- "createdTimestamp": 0,
- "creatorType": "WEB_API",
- "creatorPersonId": "string",
- "targetId": "string",
- "targetType": "ANONYMOUS",
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
], - "redeemingPersonId": "string",
- "comment": "string",
- "email": "string",
- "nickname": "string",
- "expirationTimestamp": 0
}
Renews the PIN of an anonymous visitor PIN invitation. An error is returned if the method is called for any other type of invitation.
invitationId required | string Invitation id. |
{- "$_type": "ConversationInvitationData",
- "accountId": "string",
- "invitationType": "CONVERSATION_REQUEST",
- "invitationState": "OPEN",
- "id": "string",
- "conversationId": "string",
- "token": "string",
- "createdTimestamp": 0,
- "creatorType": "WEB_API",
- "creatorPersonId": "string",
- "targetId": "string",
- "targetType": "ANONYMOUS",
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
], - "redeemingPersonId": "string",
- "comment": "string",
- "email": "string",
- "nickname": "string",
- "expirationTimestamp": 0
}
Return the given conversation to the queue by creating an assignment request invitation.
This is only possible for conversations that were initiated by the visitor, that is, the conversation's initial engagement type must be a request.
Optionally, existing agent participants can be removed from the conversation.
conversationId | string Conversation id. |
agentRemovalType | string (EAgentRemovalType) Enum: "KEEP_AGENTS" "REMOVE_ASSIGNED_AGENT" "REMOVE_ALL_AGENTS" enum-descriptions: ["KEEP_AGENTS","REMOVE_ASSIGNED_AGENT","REMOVE_ALL_AGENTS"] |
{- "conversationId": "string",
- "agentRemovalType": "KEEP_AGENTS"
}
{- "$_type": "ConversationInvitationData",
- "accountId": "string",
- "invitationType": "CONVERSATION_REQUEST",
- "invitationState": "OPEN",
- "id": "string",
- "conversationId": "string",
- "token": "string",
- "createdTimestamp": 0,
- "creatorType": "WEB_API",
- "creatorPersonId": "string",
- "targetId": "string",
- "targetType": "ANONYMOUS",
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
], - "redeemingPersonId": "string",
- "comment": "string",
- "email": "string",
- "nickname": "string",
- "expirationTimestamp": 0
}
Revokes the invitation making it impossible to accept it anymore.
invitationId required | string Invitation id. |
{- "$_type": "ConversationInvitationData",
- "accountId": "string",
- "invitationType": "CONVERSATION_REQUEST",
- "invitationState": "OPEN",
- "id": "string",
- "conversationId": "string",
- "token": "string",
- "createdTimestamp": 0,
- "creatorType": "WEB_API",
- "creatorPersonId": "string",
- "targetId": "string",
- "targetType": "ANONYMOUS",
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
], - "redeemingPersonId": "string",
- "comment": "string",
- "email": "string",
- "nickname": "string",
- "expirationTimestamp": 0
}
Search for invitations in the current account
$_type | string Default: "ConversationInvitationQuery" Value: "ConversationInvitationQuery" |
Array of any (ConversationInvitationSearchFilter) [ items ] List of filters to narrow the search of entities | |
Array of objects (ConversationInvitationOrderBy) [ items ] List of criteria to order the search result list | |
offset | integer <int32> Offset position in the result set to start pagination |
limit | integer <int32> Maximal amount of items returned |
{- "$_type": "ConversationInvitationQuery",
- "searchFilters": [
- {
- "$_type": "TargetTypeConversationInvitationSearchFilter",
- "field": "INVITATION_TYPE",
- "operator": {
- "$_type": "EqualsInvitationTargetTypeOperator",
- "type": "EQUALS",
- "value": "ANONYMOUS"
}
}
], - "orderBy": [
- {
- "$_type": "ConversationInvitationOrderBy",
- "field": "TYPE",
- "order": "ASCENDING"
}
], - "offset": 0,
- "limit": 0
}
{- "$_type": "ConversationInvitationResult",
- "hasMoreItems": true,
- "nextOffset": 0,
- "items": [
- {
- "$_type": "ConversationInvitationData",
- "accountId": "string",
- "invitationType": "CONVERSATION_REQUEST",
- "invitationState": "OPEN",
- "id": "string",
- "conversationId": "string",
- "token": "string",
- "createdTimestamp": 0,
- "creatorType": "WEB_API",
- "creatorPersonId": "string",
- "targetId": "string",
- "targetType": "ANONYMOUS",
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
], - "redeemingPersonId": "string",
- "comment": "string",
- "email": "string",
- "nickname": "string",
- "expirationTimestamp": 0
}
]
}
Creates the given entity in the system. The id of the entity can not be set for create operation, a new one is generated.
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
The entity to create
$_type | string Default: "NamedArea" Value: "NamedArea" |
id | string Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway. |
creationTimestamp | integer <int64> Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
modificationTimestamp | integer <int64> Timestamp of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
version | integer <int64> Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted. |
accountId | string Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
string or Avatar (object) expand-query-key: avatar type: ExpandableField Avatar of the entity: id that can be expanded. | |
name | string Name of the named area. Maximum of 250 characters. Can not be omitted. |
description | string Description of the named area. Maximum of 500 characters. Can be omitted. |
type | string (ENamedAreaType) Enum: "META_TAG" "DOMAIN" enum-descriptions: ["META_TAG: A meta tag","DOMAIN: a (sub)domain"] Type of a named area |
siteId | string Meta tag name if the type is META_TAG or domain name if the type is DOMAIN. If the type is META_TAG, it can be omitted during creation and a random ID will generated for it. Modification of this attribute is not allowed. Maximum of 250 characters. |
object expand-query-key: configuration type: Map The entity's configuration properties. Only contains values when the 'expand' query parameter is used with the value 'configuration'. | |
object expand-query-key: text type: Map The entity's text properties. Only contains values when the 'expand' query parameter is used with the value 'text'. | |
object expand-query-key: metadata type: Map The entity's metadata properties. Only contains values when the 'expand' query parameter is used with the value 'metadata'. |
{- "$_type": "NamedArea",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "avatar": "string",
- "name": "string",
- "description": "string",
- "type": "META_TAG",
- "siteId": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
{- "$_type": "NamedArea",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "avatar": "string",
- "name": "string",
- "description": "string",
- "type": "META_TAG",
- "siteId": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
Deletes the entity for the given id
id | string The id of the entity which should be deleted |
{- "$_type": "Error",
- "statusCode": 0,
- "statusDescription": "string",
- "errorMessage": "string"
}
Returns the named area for the given id
id | string Id of the named area which should be returned |
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
{- "$_type": "NamedArea",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "avatar": "string",
- "name": "string",
- "description": "string",
- "type": "META_TAG",
- "siteId": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
Gets a list of named areas for the given id's
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
The id's for which the named areas should be fetched
[- "string"
]
[- {
- "$_type": "NamedArea",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "avatar": "string",
- "name": "string",
- "description": "string",
- "type": "META_TAG",
- "siteId": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
]
Search for named areas in the current account
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
$_type | string Default: "NamedAreaQuery" Value: "NamedAreaQuery" |
Array of any (NamedAreaSearchFilter) [ items ] List of filters to narrow the search of entities | |
Array of objects (NamedAreaOrderBy) [ items ] List of criteria to order the search result list | |
offset | integer <int32> Offset position in the result set to start pagination |
limit | integer <int32> Maximal amount of items returned |
{- "$_type": "NamedAreaQuery",
- "searchFilters": [
- {
- "$_type": "CreationTimestampNamedAreaSearchFilter",
- "field": "NAME",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
], - "orderBy": [
- {
- "$_type": "NamedAreaOrderBy",
- "field": "ID",
- "order": "ASCENDING"
}
], - "offset": 0,
- "limit": 0
}
{- "$_type": "NamedAreaResult",
- "hasMoreItems": true,
- "nextOffset": 0,
- "items": [
- {
- "$_type": "NamedArea",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "avatar": "string",
- "name": "string",
- "description": "string",
- "type": "META_TAG",
- "siteId": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
]
}
Updates the entity in the system with the given entity.
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
The entity to update
$_type | string Default: "NamedArea" Value: "NamedArea" |
id | string Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway. |
creationTimestamp | integer <int64> Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
modificationTimestamp | integer <int64> Timestamp of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
version | integer <int64> Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted. |
accountId | string Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
string or Avatar (object) expand-query-key: avatar type: ExpandableField Avatar of the entity: id that can be expanded. | |
name | string Name of the named area. Maximum of 250 characters. Can not be omitted. |
description | string Description of the named area. Maximum of 500 characters. Can be omitted. |
type | string (ENamedAreaType) Enum: "META_TAG" "DOMAIN" enum-descriptions: ["META_TAG: A meta tag","DOMAIN: a (sub)domain"] Type of a named area |
siteId | string Meta tag name if the type is META_TAG or domain name if the type is DOMAIN. If the type is META_TAG, it can be omitted during creation and a random ID will generated for it. Modification of this attribute is not allowed. Maximum of 250 characters. |
object expand-query-key: configuration type: Map The entity's configuration properties. Only contains values when the 'expand' query parameter is used with the value 'configuration'. | |
object expand-query-key: text type: Map The entity's text properties. Only contains values when the 'expand' query parameter is used with the value 'text'. | |
object expand-query-key: metadata type: Map The entity's metadata properties. Only contains values when the 'expand' query parameter is used with the value 'metadata'. |
{- "$_type": "NamedArea",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "avatar": "string",
- "name": "string",
- "description": "string",
- "type": "META_TAG",
- "siteId": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
{- "$_type": "NamedArea",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "avatar": "string",
- "name": "string",
- "description": "string",
- "type": "META_TAG",
- "siteId": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
Helper method read a PersonPresenceData
by id
id | string |
{- "$_type": "PersonPresenceData",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "accountId": "string",
- "joinedTimestamp": 0,
- "leftTimestamp": 0,
- "personId": "string",
- "deviceInfo": {
- "$_type": "DeviceInfo",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "accountId": "string",
- "osName": "string",
- "osVersion": "string",
- "browserName": "string",
- "browserVersion": "string",
- "userAgent": "string",
- "screenWidth": 0,
- "screenHeight": 0,
- "screenPixelRatio": 0,
- "type": "MOBILE",
- "identifier": "string",
- "identifierSource": "COOKIE",
- "pushToken": "string",
- "ownerPersonId": "string"
}, - "touchTimestamp": 0,
- "impersonationType": "NONE",
- "impersonatedFromUserId": "string",
- "impersonatedFromAccountId": "string",
- "additionalInfo": "string",
- "authInfo": "string",
- "propagated": true
}
Search for person presences in the current account
$_type | string Default: "PersonPresenceQuery" Value: "PersonPresenceQuery" |
Array of any (PersonPresenceSearchFilter) [ items ] List of filters to narrow the search of entities | |
Array of objects (PersonPresenceOrderBy) [ items ] List of criteria to order the search result list | |
offset | integer <int32> Offset position in the result set to start pagination |
limit | integer <int32> Maximal amount of items returned |
{- "$_type": "PersonPresenceQuery",
- "searchFilters": [
- {
- "$_type": "JoinedTimestampPersonPresenceSearchFilter",
- "field": "JOINED_TIMESTAMP",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
], - "orderBy": [
- {
- "$_type": "PersonPresenceOrderBy",
- "field": "CREATION_TIMESTAMP",
- "order": "ASCENDING"
}
], - "offset": 0,
- "limit": 0
}
{- "$_type": "PersonPresenceResult",
- "hasMoreItems": true,
- "nextOffset": 0,
- "items": [
- {
- "$_type": "PersonPresenceData",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "accountId": "string",
- "joinedTimestamp": 0,
- "leftTimestamp": 0,
- "personId": "string",
- "deviceInfo": {
- "$_type": "DeviceInfo",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "accountId": "string",
- "osName": "string",
- "osVersion": "string",
- "browserName": "string",
- "browserVersion": "string",
- "userAgent": "string",
- "screenWidth": 0,
- "screenHeight": 0,
- "screenPixelRatio": 0,
- "type": "MOBILE",
- "identifier": "string",
- "identifierSource": "COOKIE",
- "pushToken": "string",
- "ownerPersonId": "string"
}, - "touchTimestamp": 0,
- "impersonationType": "NONE",
- "impersonatedFromUserId": "string",
- "impersonatedFromAccountId": "string",
- "additionalInfo": "string",
- "authInfo": "string",
- "propagated": true
}
]
}
Updates and returns an existing bot person or creates and returns a bot person if absent.
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
person data
$_type | string Default: "PersonData" Value: "PersonData" |
id | string Unique id of the person, when creating a person this property can be omitted as it will be generated by the server anyway. |
accountId | string Account id to which a Person belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
personSource | string (EPersonSource) Enum: "USER_DB" "VIRTUAL" enum-descriptions: ["USER_DB: Person-Source is on the main_user table","VIRTUAL: Person-Source is only virtual (no seperate storage)"] The source type of a person (participant of a conversation) |
sourceId | string Identifier of the person in its source (defined by |
sourceData | string Vendor specific data. |
firstName | string The first name of the person. Maximum length of 250 characters. Can be omitted. |
lastName | string the last name of the person. Maximum length of 250 characters. Can be omitted. |
username | string The username of the person. When firstName and lastName are unknown, it is recommended to use this value to change the displayName. Depending on the configuration, this is may also be the email of the corresponding user. Maximum length of 250 characters. Can be omitted. |
nickname | string A name that an anonymous person has given itself. Maximum length of 250 characters. Can be omitted. |
displayName | string Display name of the person. This is read only information, it will be set by the server anyway. |
personType | string (EPersonType) Enum: "AGENT" "VISITOR" "SYSTEM" "BOT" enum-descriptions: ["AGENT: Agent participant","VISITOR: Visitor participant","SYSTEM: System participant","BOT: Bot participant"] The type of a person (participant of a session) |
authorizationRole | string (EAuthorizationRole) Enum: "SUPER_ADMIN" "PARTNER" "TECHNICAL_ADMIN" "ADMIN" "SUPERVISOR" "REGISTERED_USER" "WEBUSER" "ANONYMOUS_USER" enum-descriptions: ["SUPER_ADMIN: Super admin role. Only for unblu or system admins","PARTNER: Partner role. (no longer used)","TECHNICAL_ADMIN: Technical admin role.","ADMIN: Admin role. For Admins of the system","SUPERVISOR: Supervisor role. For users which manage teams","REGISTERED_USER: User role. For normal users (agents)","WEBUSER: Webuser role. For internal representation of users from the outside","ANONYMOUS_USER: Anonymous role. For internal representation of unknown users"] The authorization role is mainly used for access definition of a service |
string The email of the person. Optional. | |
phone | string The phone of the person. Optional. |
teamId | string Team id of the person. Optional. |
teamName | string Team name of the person, only present when the team id is set. When creating or updating a person this property can be omitted as it will be set by the server anyway. |
string or Avatar (object) expand-query-key: avatar type: ExpandableField Avatar of the entity: id that can be expanded. | |
object expand-query-key: metadata type: Map The entity's metadata properties. Only contains values when the 'expand' query parameter is used with the value 'metadata'. |
{- "$_type": "PersonData",
- "id": null,
- "accountId": null,
- "personSource": null,
- "sourceId": "b",
- "sourceData": null,
- "firstName": null,
- "lastName": null,
- "username": "Example B",
- "nickname": null,
- "displayName": null,
- "personType": null,
- "authorizationRole": null,
- "email": "b@example.com",
- "phone": null,
- "teamId": null,
- "teamName": null,
- "avatar": null,
- "metadata": null
}
{- "$_type": "PersonData",
- "id": "nta30CBa-6d1a89cE57Db_F",
- "accountId": "A7d9E_0-c3cC4aoFDb85t6n",
- "personSource": "VIRTUAL",
- "sourceId": "bot3",
- "sourceData": null,
- "firstName": null,
- "lastName": null,
- "username": "Example BOT3",
- "nickname": null,
- "displayName": "Bot",
- "personType": "BOT",
- "authorizationRole": "REGISTERED_USER",
- "email": "bot3@example.com",
- "phone": null,
- "teamId": null,
- "teamName": null,
- "avatar": null,
- "metadata": null
}
Updates and returns an existing virtual person or creates and returns a virtual person if absent.
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
person data
$_type | string Default: "PersonData" Value: "PersonData" |
id | string Unique id of the person, when creating a person this property can be omitted as it will be generated by the server anyway. |
accountId | string Account id to which a Person belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
personSource | string (EPersonSource) Enum: "USER_DB" "VIRTUAL" enum-descriptions: ["USER_DB: Person-Source is on the main_user table","VIRTUAL: Person-Source is only virtual (no seperate storage)"] The source type of a person (participant of a conversation) |
sourceId | string Identifier of the person in its source (defined by |
sourceData | string Vendor specific data. |
firstName | string The first name of the person. Maximum length of 250 characters. Can be omitted. |
lastName | string the last name of the person. Maximum length of 250 characters. Can be omitted. |
username | string The username of the person. When firstName and lastName are unknown, it is recommended to use this value to change the displayName. Depending on the configuration, this is may also be the email of the corresponding user. Maximum length of 250 characters. Can be omitted. |
nickname | string A name that an anonymous person has given itself. Maximum length of 250 characters. Can be omitted. |
displayName | string Display name of the person. This is read only information, it will be set by the server anyway. |
personType | string (EPersonType) Enum: "AGENT" "VISITOR" "SYSTEM" "BOT" enum-descriptions: ["AGENT: Agent participant","VISITOR: Visitor participant","SYSTEM: System participant","BOT: Bot participant"] The type of a person (participant of a session) |
authorizationRole | string (EAuthorizationRole) Enum: "SUPER_ADMIN" "PARTNER" "TECHNICAL_ADMIN" "ADMIN" "SUPERVISOR" "REGISTERED_USER" "WEBUSER" "ANONYMOUS_USER" enum-descriptions: ["SUPER_ADMIN: Super admin role. Only for unblu or system admins","PARTNER: Partner role. (no longer used)","TECHNICAL_ADMIN: Technical admin role.","ADMIN: Admin role. For Admins of the system","SUPERVISOR: Supervisor role. For users which manage teams","REGISTERED_USER: User role. For normal users (agents)","WEBUSER: Webuser role. For internal representation of users from the outside","ANONYMOUS_USER: Anonymous role. For internal representation of unknown users"] The authorization role is mainly used for access definition of a service |
string The email of the person. Optional. | |
phone | string The phone of the person. Optional. |
teamId | string Team id of the person. Optional. |
teamName | string Team name of the person, only present when the team id is set. When creating or updating a person this property can be omitted as it will be set by the server anyway. |
string or Avatar (object) expand-query-key: avatar type: ExpandableField Avatar of the entity: id that can be expanded. | |
object expand-query-key: metadata type: Map The entity's metadata properties. Only contains values when the 'expand' query parameter is used with the value 'metadata'. |
{- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}
{- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}
Returns a person by source
personSource | string (EPersonSource) Enum: "USER_DB" "VIRTUAL" enum-descriptions: ["USER_DB: Person-Source is on the main_user table","VIRTUAL: Person-Source is only virtual (no seperate storage)"] Source of the of the person |
sourceId | string Identifier of the person in its source |
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
{- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}
Method to read a PersonData
by id
id | string the personId |
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
{- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}
Search for persons in the current account
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
$_type | string Default: "PersonQuery" Value: "PersonQuery" |
Array of any (PersonSearchFilter) [ items ] List of filters to narrow the search of entities | |
Array of objects (PersonOrderBy) [ items ] List of criteria to order the search result list | |
offset | integer <int32> Offset position in the result set to start pagination |
limit | integer <int32> Maximal amount of items returned |
{- "$_type": "PersonQuery",
- "searchFilters": [
- {
- "$_type": "AuthorizationRolePersonSearchFilter",
- "field": "PERSON_SOURCE",
- "operator": {
- "$_type": "EqualsAuthorizationRoleOperator",
- "type": "EQUALS",
- "value": "SUPER_ADMIN"
}
}
], - "orderBy": [
- {
- "$_type": "PersonOrderBy",
- "field": "ID",
- "order": "ASCENDING"
}
], - "offset": 0,
- "limit": 0
}
{- "$_type": "PersonResult",
- "hasMoreItems": true,
- "nextOffset": 0,
- "items": [
- {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}
]
}
Returns the webhook event type names matching certain condition
apiVersion | string (EWebApiVersion) Enum: "V1" "V2" "V3" enum-descriptions: ["V1: Version 1 of the Web-API. Introduced with Unblu 4.x.","V2: Version 2 of the Web-API. Introduced with Unblu 5.","V3: Version 3 of the Web-API. Introduced with Unblu 6."] only the events compatible with this version will be returned. If null the newest Web-API version will be used. |
registrationLocation | string (ERegistrationLocation) Enum: "WEBHOOK_REGISTRATION" "BOT" "EXTERNAL_MESSENGER" enum-descriptions: ["WEBHOOK_REGISTRATION","BOT","EXTERNAL_MESSENGER"] only the events having this registration location will be returned. If null all location will be considered |
[- "string"
]
Returns a list of all available services
[- {
- "$_type": "WebApiService",
- "documentation": "string",
- "name": "string",
- "implementationName": "string",
- "resources": [
- {
- "$_type": "ResourceMetadata",
- "documentation": "string",
- "requiredRole": [
- "string"
], - "requiredCallOrigin": "string",
- "path": [
- {
- "$_type": "ResourcePathElement",
- "documentation": "string",
- "name": "string",
- "dynamic": true,
- "type": "string"
}
], - "queryParameters": [
- {
- "$_type": "QueryParameter",
- "documentation": "string",
- "name": "string",
- "type": "string"
}
], - "body": {
- "$_type": "BodyElement",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- {
- "$_type": "ServiceTypeBinding",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- { }
]
}
], - "name": "string",
- "documentation": "string"
}, - "returnDocumentation": "string",
- "returnType": {
- "$_type": "ServiceTypeBinding",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- { }
]
}, - "isGetAll": true,
- "methodType": "GET"
}
]
}
]
Returns all metadata information available in one batch
{- "$_type": "ServicesContainer",
- "version": "string",
- "services": [
- {
- "$_type": "WebApiService",
- "documentation": "string",
- "name": "string",
- "implementationName": "string",
- "resources": [
- {
- "$_type": "ResourceMetadata",
- "documentation": "string",
- "requiredRole": [
- "string"
], - "requiredCallOrigin": "string",
- "path": [
- {
- "$_type": "ResourcePathElement",
- "documentation": "string",
- "name": "string",
- "dynamic": true,
- "type": "string"
}
], - "queryParameters": [
- {
- "$_type": "QueryParameter",
- "documentation": "string",
- "name": "string",
- "type": "string"
}
], - "body": {
- "$_type": "BodyElement",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- {
- "$_type": "ServiceTypeBinding",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- { }
]
}
], - "name": "string",
- "documentation": "string"
}, - "returnDocumentation": "string",
- "returnType": {
- "$_type": "ServiceTypeBinding",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- { }
]
}, - "isGetAll": true,
- "methodType": "GET"
}
]
}
], - "webhookEvents": [
- {
- "$_type": "ServiceWebhookEventType",
- "documentation": "string",
- "name": "string",
- "implementationName": "string",
- "registrationLocation": "WEBHOOK_REGISTRATION",
- "since": "V1",
- "properties": [
- {
- "$_type": "ServiceTypeProperty",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- {
- "$_type": "ServiceTypeBinding",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- { }
]
}
], - "documentation": "string",
- "name": "string",
- "expandableType": "string"
}
], - "staticProperties": [
- {
- "$_type": "ServiceTypeProperty",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- {
- "$_type": "ServiceTypeBinding",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- { }
]
}
], - "documentation": "string",
- "name": "string",
- "expandableType": "string"
}
]
}
], - "types": [
- {
- "$_type": "ServiceType",
- "documentation": "string",
- "name": "string",
- "implementationName": "string",
- "isEnum": true,
- "additionalExpandables": [
- "string"
], - "properties": [
- {
- "$_type": "ServiceTypeProperty",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- {
- "$_type": "ServiceTypeBinding",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- { }
]
}
], - "documentation": "string",
- "name": "string",
- "expandableType": "string"
}
], - "staticProperties": [
- {
- "$_type": "ServiceTypeProperty",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- {
- "$_type": "ServiceTypeBinding",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- { }
]
}
], - "documentation": "string",
- "name": "string",
- "expandableType": "string"
}
], - "implementationTypes": [
- {
- "$_type": "ServiceTypeBinding",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- { }
]
}
], - "discriminatorName": "string"
}
]
}
Returns All available types used by the services and the webhook events
[- {
- "$_type": "ServiceType",
- "documentation": "string",
- "name": "string",
- "implementationName": "string",
- "isEnum": true,
- "additionalExpandables": [
- "string"
], - "properties": [
- {
- "$_type": "ServiceTypeProperty",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- {
- "$_type": "ServiceTypeBinding",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- { }
]
}
], - "documentation": "string",
- "name": "string",
- "expandableType": "string"
}
], - "staticProperties": [
- {
- "$_type": "ServiceTypeProperty",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- {
- "$_type": "ServiceTypeBinding",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- { }
]
}
], - "documentation": "string",
- "name": "string",
- "expandableType": "string"
}
], - "implementationTypes": [
- {
- "$_type": "ServiceTypeBinding",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- { }
]
}
], - "discriminatorName": "string"
}
]
Returns all webhook event types
[- {
- "$_type": "ServiceWebhookEventType",
- "documentation": "string",
- "name": "string",
- "implementationName": "string",
- "registrationLocation": "WEBHOOK_REGISTRATION",
- "since": "V1",
- "properties": [
- {
- "$_type": "ServiceTypeProperty",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- {
- "$_type": "ServiceTypeBinding",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- { }
]
}
], - "documentation": "string",
- "name": "string",
- "expandableType": "string"
}
], - "staticProperties": [
- {
- "$_type": "ServiceTypeProperty",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- {
- "$_type": "ServiceTypeBinding",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- { }
]
}
], - "documentation": "string",
- "name": "string",
- "expandableType": "string"
}
]
}
]
Returns the metadata for the requested service
serviceName required | string The name of the service of which the metadata should be returned |
{- "$_type": "WebApiService",
- "documentation": "string",
- "name": "string",
- "implementationName": "string",
- "resources": [
- {
- "$_type": "ResourceMetadata",
- "documentation": "string",
- "requiredRole": [
- "string"
], - "requiredCallOrigin": "string",
- "path": [
- {
- "$_type": "ResourcePathElement",
- "documentation": "string",
- "name": "string",
- "dynamic": true,
- "type": "string"
}
], - "queryParameters": [
- {
- "$_type": "QueryParameter",
- "documentation": "string",
- "name": "string",
- "type": "string"
}
], - "body": {
- "$_type": "BodyElement",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- {
- "$_type": "ServiceTypeBinding",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- { }
]
}
], - "name": "string",
- "documentation": "string"
}, - "returnDocumentation": "string",
- "returnType": {
- "$_type": "ServiceTypeBinding",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- { }
]
}, - "isGetAll": true,
- "methodType": "GET"
}
]
}
Returns a type definition by the given name
name required | string The name of the type of which the metadata should be returned |
{- "$_type": "ServiceType",
- "documentation": "string",
- "name": "string",
- "implementationName": "string",
- "isEnum": true,
- "additionalExpandables": [
- "string"
], - "properties": [
- {
- "$_type": "ServiceTypeProperty",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- {
- "$_type": "ServiceTypeBinding",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- { }
]
}
], - "documentation": "string",
- "name": "string",
- "expandableType": "string"
}
], - "staticProperties": [
- {
- "$_type": "ServiceTypeProperty",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- {
- "$_type": "ServiceTypeBinding",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- { }
]
}
], - "documentation": "string",
- "name": "string",
- "expandableType": "string"
}
], - "implementationTypes": [
- {
- "$_type": "ServiceTypeBinding",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- { }
]
}
], - "discriminatorName": "string"
}
Returns the webhook event type definition for the requested webhook event
name required | string The name of the webhook event type of which the metadata should be returned |
{- "$_type": "ServiceWebhookEventType",
- "documentation": "string",
- "name": "string",
- "implementationName": "string",
- "registrationLocation": "WEBHOOK_REGISTRATION",
- "since": "V1",
- "properties": [
- {
- "$_type": "ServiceTypeProperty",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- {
- "$_type": "ServiceTypeBinding",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- { }
]
}
], - "documentation": "string",
- "name": "string",
- "expandableType": "string"
}
], - "staticProperties": [
- {
- "$_type": "ServiceTypeProperty",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- {
- "$_type": "ServiceTypeBinding",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- { }
]
}
], - "documentation": "string",
- "name": "string",
- "expandableType": "string"
}
]
}
Service to manage all teams in the system. For each account there is always a default team, which users are assigned to, when no explicit team is set.
Creates the given entity in the system. The id of the entity can not be set for create operation, a new one is generated.
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
The entity to create
$_type | string Default: "Team" Value: "Team" |
id | string Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway. |
creationTimestamp | integer <int64> Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
modificationTimestamp | integer <int64> Timestamp of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
version | integer <int64> Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted. |
accountId | string Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
string or Avatar (object) expand-query-key: avatar type: ExpandableField Avatar of the entity: id that can be expanded. | |
name | string Name of the team. Maximum of 250 characters. Can not be omitted. |
parentId | string Id of the parent team. Only the default team has no parent team. When creating a team and the parentId is omitted, the default team is automatically inserted by the server. |
description | string Description of the team. Maximum of 500 characters. Can be omitted. |
externallyManaged | boolean True if the team is externally managed and cannot be edited in the Unblu user interface. If omitted, the property is set to false. |
object expand-query-key: configuration type: Map The entity's configuration properties. Only contains values when the 'expand' query parameter is used with the value 'configuration'. | |
object expand-query-key: metadata type: Map The entity's metadata properties. Only contains values when the 'expand' query parameter is used with the value 'metadata'. |
{- "$_type": "Team",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "avatar": "string",
- "name": "string",
- "parentId": "string",
- "description": "string",
- "externallyManaged": true,
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
{- "$_type": "Team",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "avatar": "string",
- "name": "string",
- "parentId": "string",
- "description": "string",
- "externallyManaged": true,
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
Deletes the entity for the given id
id | string The id of the entity which should be deleted |
{- "$_type": "Error",
- "statusCode": 0,
- "statusDescription": "string",
- "errorMessage": "string"
}
Returns a list of teams, which directly belong to the given parent team.
parentId | string The id of the parent for which the direct child teams should be returned |
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
[- {
- "$_type": "Team",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "avatar": "string",
- "name": "string",
- "parentId": "string",
- "description": "string",
- "externallyManaged": true,
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
]
Returns a list of teams ids, which recursively belong to the given parent team. So child teams of a child team are also listed
teamId | string The ID of the parent team for which the child teams should be returned recursively |
[- "string"
]
Returns a list of teams, which recursively belong to the given parent team. So child teams of a child team are also listed
teamId | string The ID of the parent team for which the child teams should be returned recursively |
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
[- {
- "$_type": "Team",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "avatar": "string",
- "name": "string",
- "parentId": "string",
- "description": "string",
- "externallyManaged": true,
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
]
Returns the team of the current logged in user. There is always a team, at least the default team.
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
{- "$_type": "Team",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "avatar": "string",
- "name": "string",
- "parentId": "string",
- "description": "string",
- "externallyManaged": true,
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
Returns the team for the given id
id | string Id of the team which should be returned |
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
{- "$_type": "Team",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "avatar": "string",
- "name": "string",
- "parentId": "string",
- "description": "string",
- "externallyManaged": true,
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
Gets a list of teams for the given id's
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
The id's for which the teams should be fetched
[- "string"
]
[- {
- "$_type": "Team",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "avatar": "string",
- "name": "string",
- "parentId": "string",
- "description": "string",
- "externallyManaged": true,
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
]
Search for teams in the current account
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
$_type | string Default: "TeamQuery" Value: "TeamQuery" |
Array of any (TeamSearchFilter) [ items ] List of filters to narrow the search of entities | |
Array of objects (TeamOrderBy) [ items ] List of criteria to order the search result list | |
offset | integer <int32> Offset position in the result set to start pagination |
limit | integer <int32> Maximal amount of items returned |
{- "$_type": "TeamQuery",
- "searchFilters": [
- {
- "$_type": "CreationTimestampTeamSearchFilter",
- "field": "NAME",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
], - "orderBy": [
- {
- "$_type": "TeamOrderBy",
- "field": "ID",
- "order": "ASCENDING"
}
], - "offset": 0,
- "limit": 0
}
{- "$_type": "TeamResult",
- "hasMoreItems": true,
- "nextOffset": 0,
- "items": [
- {
- "$_type": "Team",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "avatar": "string",
- "name": "string",
- "parentId": "string",
- "description": "string",
- "externallyManaged": true,
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
]
}
Checks if the subTeamId is a child team of the parentTeamId.
If isParentTeamItselfAllowed is true, this functions returns true if subTeamId is equals parentTeamId.
This check is recursive. It will check all parent teams of the sub team until it either finds the given parent team or if there is no parent team anymore.
parentTeamId | string The parent team id against which the check should be done |
subTeamId | string The sub team id, which is checked against the parent team id |
true
Updates the team entity with the given instance. A supervisor can change his team and all sub teams
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
The entity to update
$_type | string Default: "Team" Value: "Team" |
id | string Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway. |
creationTimestamp | integer <int64> Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
modificationTimestamp | integer <int64> Timestamp of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
version | integer <int64> Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted. |
accountId | string Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
string or Avatar (object) expand-query-key: avatar type: ExpandableField Avatar of the entity: id that can be expanded. | |
name | string Name of the team. Maximum of 250 characters. Can not be omitted. |
parentId | string Id of the parent team. Only the default team has no parent team. When creating a team and the parentId is omitted, the default team is automatically inserted by the server. |
description | string Description of the team. Maximum of 500 characters. Can be omitted. |
externallyManaged | boolean True if the team is externally managed and cannot be edited in the Unblu user interface. If omitted, the property is set to false. |
object expand-query-key: configuration type: Map The entity's configuration properties. Only contains values when the 'expand' query parameter is used with the value 'configuration'. | |
object expand-query-key: metadata type: Map The entity's metadata properties. Only contains values when the 'expand' query parameter is used with the value 'metadata'. |
{- "$_type": "Team",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "avatar": "string",
- "name": "string",
- "parentId": "string",
- "description": "string",
- "externallyManaged": true,
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
{- "$_type": "Team",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "avatar": "string",
- "name": "string",
- "parentId": "string",
- "description": "string",
- "externallyManaged": true,
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
Service to manage all users in the system. Most of the service's endpoints to read, list, or search for users exclude virtual visitors from the results. If an endpoint returns virtual visitors, it will be noted in the endpoint's description.
Creates the given entity in the system. The id of the entity can not be set for create operation, a new one is generated.
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
The entity to create
$_type | string Default: "User" Value: "User" |
id | string Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway. |
creationTimestamp | integer <int64> Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
modificationTimestamp | integer <int64> Timestamp of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
version | integer <int64> Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted. |
accountId | string Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
string or Avatar (object) expand-query-key: avatar type: ExpandableField Avatar of the entity: id that can be expanded. | |
username | string The username for the login. Depending on the configuration, this is may also the email. Maximum length of 250 characters. Can not be omitted. When creating/updating a user and configuration 'storage.user.useEmailAsUsername' is enabled, this value must be the same as the email address. |
string The email address of the user. Maximum length of 250 characters. Can not be omitted, but can be an empty string, if storage.user.useEmailAsUsername is not used. | |
phone | string The phone number of the user. Maximum length of 100 characters. |
teamId | string The id of the team the user belongs to. This can be omitted, when creating a user and will be filled by the server with the default team id of the account. |
authorizationRole | string (EAuthorizationRole) Enum: "SUPER_ADMIN" "PARTNER" "TECHNICAL_ADMIN" "ADMIN" "SUPERVISOR" "REGISTERED_USER" "WEBUSER" "ANONYMOUS_USER" enum-descriptions: ["SUPER_ADMIN: Super admin role. Only for unblu or system admins","PARTNER: Partner role. (no longer used)","TECHNICAL_ADMIN: Technical admin role.","ADMIN: Admin role. For Admins of the system","SUPERVISOR: Supervisor role. For users which manage teams","REGISTERED_USER: User role. For normal users (agents)","WEBUSER: Webuser role. For internal representation of users from the outside","ANONYMOUS_USER: Anonymous role. For internal representation of unknown users"] The authorization role is mainly used for access definition of a service |
displayName | string The display name of the user. Will be calculated by the server. Can be omitted while creating a user. |
firstName | string The first name of the user. Maximum length of 250 characters. Can not be omitted. |
lastName | string The user's last name. Maximum length of 250 characters. Cannot be omitted. |
externallyManaged | boolean True if the user is externally managed and cannot be edited in the Unblu user interface. If omitted, the property is set to false. |
virtualUser | boolean True if the user is pure virtual (i.e. not created beforehand by LDAP sync for instance) and therefore can not be edited by the Unblu user interface. If omitted, the property is set to false. |
object expand-query-key: configuration type: Map The entity's configuration properties. Only contains values when the 'expand' query parameter is used with the value 'configuration'. | |
object expand-query-key: metadata type: Map The entity's metadata properties. Only contains values when the 'expand' query parameter is used with the value 'metadata'. |
{- "$_type": "User",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "avatar": "string",
- "username": "string",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "authorizationRole": "SUPER_ADMIN",
- "displayName": "string",
- "firstName": "string",
- "lastName": "string",
- "externallyManaged": true,
- "virtualUser": true,
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
{- "$_type": "User",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "avatar": "string",
- "username": "string",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "authorizationRole": "SUPER_ADMIN",
- "displayName": "string",
- "firstName": "string",
- "lastName": "string",
- "externallyManaged": true,
- "virtualUser": true,
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
Creates a new user with a random password. The random password is returned and also send via email, if email is correctly configured.
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
The user data with which the new user is created
$_type | string Default: "User" Value: "User" |
id | string Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway. |
creationTimestamp | integer <int64> Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
modificationTimestamp | integer <int64> Timestamp of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
version | integer <int64> Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted. |
accountId | string Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
string or Avatar (object) expand-query-key: avatar type: ExpandableField Avatar of the entity: id that can be expanded. | |
username | string The username for the login. Depending on the configuration, this is may also the email. Maximum length of 250 characters. Can not be omitted. When creating/updating a user and configuration 'storage.user.useEmailAsUsername' is enabled, this value must be the same as the email address. |
string The email address of the user. Maximum length of 250 characters. Can not be omitted, but can be an empty string, if storage.user.useEmailAsUsername is not used. | |
phone | string The phone number of the user. Maximum length of 100 characters. |
teamId | string The id of the team the user belongs to. This can be omitted, when creating a user and will be filled by the server with the default team id of the account. |
authorizationRole | string (EAuthorizationRole) Enum: "SUPER_ADMIN" "PARTNER" "TECHNICAL_ADMIN" "ADMIN" "SUPERVISOR" "REGISTERED_USER" "WEBUSER" "ANONYMOUS_USER" enum-descriptions: ["SUPER_ADMIN: Super admin role. Only for unblu or system admins","PARTNER: Partner role. (no longer used)","TECHNICAL_ADMIN: Technical admin role.","ADMIN: Admin role. For Admins of the system","SUPERVISOR: Supervisor role. For users which manage teams","REGISTERED_USER: User role. For normal users (agents)","WEBUSER: Webuser role. For internal representation of users from the outside","ANONYMOUS_USER: Anonymous role. For internal representation of unknown users"] The authorization role is mainly used for access definition of a service |
displayName | string The display name of the user. Will be calculated by the server. Can be omitted while creating a user. |
firstName | string The first name of the user. Maximum length of 250 characters. Can not be omitted. |
lastName | string The user's last name. Maximum length of 250 characters. Cannot be omitted. |
externallyManaged | boolean True if the user is externally managed and cannot be edited in the Unblu user interface. If omitted, the property is set to false. |
virtualUser | boolean True if the user is pure virtual (i.e. not created beforehand by LDAP sync for instance) and therefore can not be edited by the Unblu user interface. If omitted, the property is set to false. |
object expand-query-key: configuration type: Map The entity's configuration properties. Only contains values when the 'expand' query parameter is used with the value 'configuration'. | |
object expand-query-key: metadata type: Map The entity's metadata properties. Only contains values when the 'expand' query parameter is used with the value 'metadata'. |
{- "$_type": "User",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "avatar": "string",
- "username": "string",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "authorizationRole": "SUPER_ADMIN",
- "displayName": "string",
- "firstName": "string",
- "lastName": "string",
- "externallyManaged": true,
- "virtualUser": true,
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
{- "$_type": "UserPasswordContainer",
- "user": {
- "$_type": "User",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "avatar": "string",
- "username": "string",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "authorizationRole": "SUPER_ADMIN",
- "displayName": "string",
- "firstName": "string",
- "lastName": "string",
- "externallyManaged": true,
- "virtualUser": true,
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "password": "string"
}
Creates a new user with the provided password for login.
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
The user and the password which should be created
$_type | string Default: "UserPasswordContainer" Value: "UserPasswordContainer" |
object (User) Model of a user. A user is normally an agent and/or a person who manages the system | |
password | string The password which belongs to the user |
create a new user with a given password
{- "$_type": "UserPasswordContainer",
- "user": {
- "$_type": "User",
- "id": null,
- "creationTimestamp": null,
- "modificationTimestamp": null,
- "version": null,
- "accountId": null,
- "avatar": null,
- "username": "john.doe@email.com",
- "email": "john.doe@email.com",
- "phone": "+41 61 511 11 50",
- "teamId": null,
- "authorizationRole": "REGISTERED_USER",
- "displayName": null,
- "firstName": "John",
- "lastName": "Doe",
- "externallyManaged": null,
- "virtualUser": null,
- "configuration": null,
- "metadata": null
}, - "password": "L0remPf18!"
}
{- "$_type": "User",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "avatar": "string",
- "username": "string",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "authorizationRole": "SUPER_ADMIN",
- "displayName": "string",
- "firstName": "string",
- "lastName": "string",
- "externallyManaged": true,
- "virtualUser": true,
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
Deletes the entity for the given id
id | string The id of the entity which should be deleted |
{- "$_type": "Error",
- "statusCode": 0,
- "statusDescription": "string",
- "errorMessage": "string"
}
Checks if the given username exists in the system. Only checks the current account. This endpoint can be used for any type of users including virtual visitors.
username | string The username which will be looked up |
true
Returns the user for the given username.
username | string The username of the requested user |
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
{- "$_type": "User",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "avatar": "string",
- "username": "string",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "authorizationRole": "SUPER_ADMIN",
- "displayName": "string",
- "firstName": "string",
- "lastName": "string",
- "externallyManaged": true,
- "virtualUser": true,
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
Checks if the given user id belongs to a super admin user. This endpoint can be used for any type of users including virtual visitors.
userId | string The id of a user which should be checked |
true
Checks if the username is available in general or for the given userId. Checks all accounts and includes virtual visitors.
name | string The name which should be checked |
userId | string The user id of the user for who the username should be set. When set, the name of the user (for himself) is considered as available. |
true
Returns the user for the given id.
id | string Id of the user which should be returned |
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
{- "$_type": "User",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "avatar": "string",
- "username": "string",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "authorizationRole": "SUPER_ADMIN",
- "displayName": "string",
- "firstName": "string",
- "lastName": "string",
- "externallyManaged": true,
- "virtualUser": true,
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
Gets a list of users for the given id's. The response will not include virtual visitors.
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
The id's for which the users should be fetched
[- "string"
]
[- {
- "$_type": "User",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "avatar": "string",
- "username": "string",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "authorizationRole": "SUPER_ADMIN",
- "displayName": "string",
- "firstName": "string",
- "lastName": "string",
- "externallyManaged": true,
- "virtualUser": true,
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
]
Search for users in the current account. The response will not include virtual visitors.
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
$_type | string Default: "UserQuery" Value: "UserQuery" |
Array of any (UserSearchFilter) [ items ] List of filters to narrow the search of entities | |
Array of objects (UserOrderBy) [ items ] List of criteria to order the search result list | |
offset | integer <int32> Offset position in the result set to start pagination |
limit | integer <int32> Maximal amount of items returned |
{- "$_type": "UserQuery",
- "searchFilters": [
- {
- "$_type": "AuthorizationRoleUserSearchFilter",
- "field": "FIRST_NAME",
- "operator": {
- "$_type": "EqualsAuthorizationRoleOperator",
- "type": "EQUALS",
- "value": "SUPER_ADMIN"
}
}
], - "orderBy": [
- {
- "$_type": "UserOrderBy",
- "field": "ID",
- "order": "ASCENDING"
}
], - "offset": 0,
- "limit": 0
}
{- "$_type": "UserResult",
- "hasMoreItems": true,
- "nextOffset": 0,
- "items": [
- {
- "$_type": "User",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "avatar": "string",
- "username": "string",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "authorizationRole": "SUPER_ADMIN",
- "displayName": "string",
- "firstName": "string",
- "lastName": "string",
- "externallyManaged": true,
- "virtualUser": true,
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
]
}
Updates the given user with the new data.
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
The new user data
$_type | string Default: "User" Value: "User" |
id | string Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway. |
creationTimestamp | integer <int64> Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
modificationTimestamp | integer <int64> Timestamp of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
version | integer <int64> Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted. |
accountId | string Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
string or Avatar (object) expand-query-key: avatar type: ExpandableField Avatar of the entity: id that can be expanded. | |
username | string The username for the login. Depending on the configuration, this is may also the email. Maximum length of 250 characters. Can not be omitted. When creating/updating a user and configuration 'storage.user.useEmailAsUsername' is enabled, this value must be the same as the email address. |
string The email address of the user. Maximum length of 250 characters. Can not be omitted, but can be an empty string, if storage.user.useEmailAsUsername is not used. | |
phone | string The phone number of the user. Maximum length of 100 characters. |
teamId | string The id of the team the user belongs to. This can be omitted, when creating a user and will be filled by the server with the default team id of the account. |
authorizationRole | string (EAuthorizationRole) Enum: "SUPER_ADMIN" "PARTNER" "TECHNICAL_ADMIN" "ADMIN" "SUPERVISOR" "REGISTERED_USER" "WEBUSER" "ANONYMOUS_USER" enum-descriptions: ["SUPER_ADMIN: Super admin role. Only for unblu or system admins","PARTNER: Partner role. (no longer used)","TECHNICAL_ADMIN: Technical admin role.","ADMIN: Admin role. For Admins of the system","SUPERVISOR: Supervisor role. For users which manage teams","REGISTERED_USER: User role. For normal users (agents)","WEBUSER: Webuser role. For internal representation of users from the outside","ANONYMOUS_USER: Anonymous role. For internal representation of unknown users"] The authorization role is mainly used for access definition of a service |
displayName | string The display name of the user. Will be calculated by the server. Can be omitted while creating a user. |
firstName | string The first name of the user. Maximum length of 250 characters. Can not be omitted. |
lastName | string The user's last name. Maximum length of 250 characters. Cannot be omitted. |
externallyManaged | boolean True if the user is externally managed and cannot be edited in the Unblu user interface. If omitted, the property is set to false. |
virtualUser | boolean True if the user is pure virtual (i.e. not created beforehand by LDAP sync for instance) and therefore can not be edited by the Unblu user interface. If omitted, the property is set to false. |
object expand-query-key: configuration type: Map The entity's configuration properties. Only contains values when the 'expand' query parameter is used with the value 'configuration'. | |
object expand-query-key: metadata type: Map The entity's metadata properties. Only contains values when the 'expand' query parameter is used with the value 'metadata'. |
{- "$_type": "User",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "avatar": "string",
- "username": "string",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "authorizationRole": "SUPER_ADMIN",
- "displayName": "string",
- "firstName": "string",
- "lastName": "string",
- "externallyManaged": true,
- "virtualUser": true,
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
{- "$_type": "User",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "avatar": "string",
- "username": "string",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "authorizationRole": "SUPER_ADMIN",
- "displayName": "string",
- "firstName": "string",
- "lastName": "string",
- "externallyManaged": true,
- "virtualUser": true,
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
Updates a user and remove the existing password of this user. Without password the user will not be able to log in directly into the system. Users without a password are typically used in setups with ID propagation.
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
The user which should be updated (password will be removed)
$_type | string Default: "User" Value: "User" |
id | string Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway. |
creationTimestamp | integer <int64> Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
modificationTimestamp | integer <int64> Timestamp of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
version | integer <int64> Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted. |
accountId | string Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
string or Avatar (object) expand-query-key: avatar type: ExpandableField Avatar of the entity: id that can be expanded. | |
username | string The username for the login. Depending on the configuration, this is may also the email. Maximum length of 250 characters. Can not be omitted. When creating/updating a user and configuration 'storage.user.useEmailAsUsername' is enabled, this value must be the same as the email address. |
string The email address of the user. Maximum length of 250 characters. Can not be omitted, but can be an empty string, if storage.user.useEmailAsUsername is not used. | |
phone | string The phone number of the user. Maximum length of 100 characters. |
teamId | string The id of the team the user belongs to. This can be omitted, when creating a user and will be filled by the server with the default team id of the account. |
authorizationRole | string (EAuthorizationRole) Enum: "SUPER_ADMIN" "PARTNER" "TECHNICAL_ADMIN" "ADMIN" "SUPERVISOR" "REGISTERED_USER" "WEBUSER" "ANONYMOUS_USER" enum-descriptions: ["SUPER_ADMIN: Super admin role. Only for unblu or system admins","PARTNER: Partner role. (no longer used)","TECHNICAL_ADMIN: Technical admin role.","ADMIN: Admin role. For Admins of the system","SUPERVISOR: Supervisor role. For users which manage teams","REGISTERED_USER: User role. For normal users (agents)","WEBUSER: Webuser role. For internal representation of users from the outside","ANONYMOUS_USER: Anonymous role. For internal representation of unknown users"] The authorization role is mainly used for access definition of a service |
displayName | string The display name of the user. Will be calculated by the server. Can be omitted while creating a user. |
firstName | string The first name of the user. Maximum length of 250 characters. Can not be omitted. |
lastName | string The user's last name. Maximum length of 250 characters. Cannot be omitted. |
externallyManaged | boolean True if the user is externally managed and cannot be edited in the Unblu user interface. If omitted, the property is set to false. |
virtualUser | boolean True if the user is pure virtual (i.e. not created beforehand by LDAP sync for instance) and therefore can not be edited by the Unblu user interface. If omitted, the property is set to false. |
object expand-query-key: configuration type: Map The entity's configuration properties. Only contains values when the 'expand' query parameter is used with the value 'configuration'. | |
object expand-query-key: metadata type: Map The entity's metadata properties. Only contains values when the 'expand' query parameter is used with the value 'metadata'. |
{- "$_type": "User",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "avatar": "string",
- "username": "string",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "authorizationRole": "SUPER_ADMIN",
- "displayName": "string",
- "firstName": "string",
- "lastName": "string",
- "externallyManaged": true,
- "virtualUser": true,
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
{- "$_type": "User",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "avatar": "string",
- "username": "string",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "authorizationRole": "SUPER_ADMIN",
- "displayName": "string",
- "firstName": "string",
- "lastName": "string",
- "externallyManaged": true,
- "virtualUser": true,
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
Updates the password of the given user.
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
userId | string The id of the user which should be updated |
password | string The new password for the user |
update password for a given user
{- "userId": "d5_2rD019scCA7eEB48U6ab",
- "password": "L0remPf18!"
}
{- "$_type": "User",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "avatar": "string",
- "username": "string",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "authorizationRole": "SUPER_ADMIN",
- "displayName": "string",
- "firstName": "string",
- "lastName": "string",
- "externallyManaged": true,
- "virtualUser": true,
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
Updates the password of a user with a new random password and also the user data. The random password is returned and also send via email, if email is correctly configured.
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
The user which should be updated with a random password
$_type | string Default: "User" Value: "User" |
id | string Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway. |
creationTimestamp | integer <int64> Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
modificationTimestamp | integer <int64> Timestamp of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
version | integer <int64> Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted. |
accountId | string Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
string or Avatar (object) expand-query-key: avatar type: ExpandableField Avatar of the entity: id that can be expanded. | |
username | string The username for the login. Depending on the configuration, this is may also the email. Maximum length of 250 characters. Can not be omitted. When creating/updating a user and configuration 'storage.user.useEmailAsUsername' is enabled, this value must be the same as the email address. |
string The email address of the user. Maximum length of 250 characters. Can not be omitted, but can be an empty string, if storage.user.useEmailAsUsername is not used. | |
phone | string The phone number of the user. Maximum length of 100 characters. |
teamId | string The id of the team the user belongs to. This can be omitted, when creating a user and will be filled by the server with the default team id of the account. |
authorizationRole | string (EAuthorizationRole) Enum: "SUPER_ADMIN" "PARTNER" "TECHNICAL_ADMIN" "ADMIN" "SUPERVISOR" "REGISTERED_USER" "WEBUSER" "ANONYMOUS_USER" enum-descriptions: ["SUPER_ADMIN: Super admin role. Only for unblu or system admins","PARTNER: Partner role. (no longer used)","TECHNICAL_ADMIN: Technical admin role.","ADMIN: Admin role. For Admins of the system","SUPERVISOR: Supervisor role. For users which manage teams","REGISTERED_USER: User role. For normal users (agents)","WEBUSER: Webuser role. For internal representation of users from the outside","ANONYMOUS_USER: Anonymous role. For internal representation of unknown users"] The authorization role is mainly used for access definition of a service |
displayName | string The display name of the user. Will be calculated by the server. Can be omitted while creating a user. |
firstName | string The first name of the user. Maximum length of 250 characters. Can not be omitted. |
lastName | string The user's last name. Maximum length of 250 characters. Cannot be omitted. |
externallyManaged | boolean True if the user is externally managed and cannot be edited in the Unblu user interface. If omitted, the property is set to false. |
virtualUser | boolean True if the user is pure virtual (i.e. not created beforehand by LDAP sync for instance) and therefore can not be edited by the Unblu user interface. If omitted, the property is set to false. |
object expand-query-key: configuration type: Map The entity's configuration properties. Only contains values when the 'expand' query parameter is used with the value 'configuration'. | |
object expand-query-key: metadata type: Map The entity's metadata properties. Only contains values when the 'expand' query parameter is used with the value 'metadata'. |
{- "$_type": "User",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "avatar": "string",
- "username": "string",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "authorizationRole": "SUPER_ADMIN",
- "displayName": "string",
- "firstName": "string",
- "lastName": "string",
- "externallyManaged": true,
- "virtualUser": true,
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
{- "$_type": "UserPasswordContainer",
- "user": {
- "$_type": "User",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "avatar": "string",
- "username": "string",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "authorizationRole": "SUPER_ADMIN",
- "displayName": "string",
- "firstName": "string",
- "lastName": "string",
- "externallyManaged": true,
- "virtualUser": true,
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "password": "string"
}
Updates the password of the given user.
expand | Array of strings (ExpandFields) Items Enum: "avatar" "billingAddress" "channelIcon" "configuration" "contactAddress" "metadata" "text" |
The user and the password which should be updated
$_type | string Default: "UserPasswordContainer" Value: "UserPasswordContainer" |
object (User) Model of a user. A user is normally an agent and/or a person who manages the system | |
password | string The password which belongs to the user |
update user and password
{- "$_type": "UserPasswordContainer",
- "user": {
- "$_type": "User",
- "id": "d5_2rD019scCA7eEB48U6ab",
- "creationTimestamp": 1546300800000,
- "modificationTimestamp": 1548979200000,
- "version": 2,
- "accountId": "A7d9E_0-c3cC4aoFDb85t6n",
- "avatar": null,
- "username": "r@email.com",
- "email": "r@email.com",
- "phone": "+41 61 511 11 50",
- "teamId": "JZh4ADRnEeasYZ5xEoyudw",
- "authorizationRole": "REGISTERED_USER",
- "displayName": null,
- "firstName": "John",
- "lastName": "Smith",
- "externallyManaged": false,
- "virtualUser": false,
- "configuration": null,
- "metadata": null
}, - "password": "L0remPf18!"
}
{- "$_type": "User",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "avatar": "string",
- "username": "string",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "authorizationRole": "SUPER_ADMIN",
- "displayName": "string",
- "firstName": "string",
- "lastName": "string",
- "externallyManaged": true,
- "virtualUser": true,
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
Checks if a user has a password defined. This endpoint can be used for any type of users including virtual visitors.
userId | string The id of the user to check |
true
Returns the entity for the given id
id | string Id of the entity which should be returned |
{- "$_type": "WebhookCallLog",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "registrationId": "string",
- "requestId": "string",
- "executionTimestamp": 0,
- "endpoint": "string",
- "retryNr": 0,
- "callId": "string",
- "eventName": "string",
- "requestHeaders": "string",
- "requestSent": "string",
- "requestSentTableColumn": "string",
- "requestFileStoreId": "string",
- "httpResponseCode": 0,
- "httpResponseReason": "string",
- "httpResponseHeaders": "string",
- "responseFromServer": "string",
- "responseFromServerTableColumn": "string",
- "responseMimeType": "string",
- "responseFileStoreId": "string"
}
Gets a list of entities for the given id's
The id's for which the entities should be fetched
[- "string"
]
[- {
- "$_type": "WebhookCallLog",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "registrationId": "string",
- "requestId": "string",
- "executionTimestamp": 0,
- "endpoint": "string",
- "retryNr": 0,
- "callId": "string",
- "eventName": "string",
- "requestHeaders": "string",
- "requestSent": "string",
- "requestSentTableColumn": "string",
- "requestFileStoreId": "string",
- "httpResponseCode": 0,
- "httpResponseReason": "string",
- "httpResponseHeaders": "string",
- "responseFromServer": "string",
- "responseFromServerTableColumn": "string",
- "responseMimeType": "string",
- "responseFileStoreId": "string"
}
]
Search for call logs in the current account
$_type | string Default: "WebhookCallLogQuery" Value: "WebhookCallLogQuery" |
Array of any (WebhookCallLogSearchFilter) [ items ] List of filters to narrow the search of entities | |
Array of objects (WebhookCallLogOrderBy) [ items ] List of criteria to order the search result list | |
offset | integer <int32> Offset position in the result set to start pagination |
limit | integer <int32> Maximal amount of items returned |
{- "$_type": "WebhookCallLogQuery",
- "searchFilters": [
- {
- "$_type": "CreationTimestampWebhookCallLogSearchFilter",
- "field": "EVENT_NAME",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
], - "orderBy": [
- {
- "$_type": "WebhookCallLogOrderBy",
- "field": "ID",
- "order": "ASCENDING"
}
], - "offset": 0,
- "limit": 0
}
{- "$_type": "WebhookCallLogResult",
- "hasMoreItems": true,
- "nextOffset": 0,
- "items": [
- {
- "$_type": "WebhookCallLog",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "registrationId": "string",
- "requestId": "string",
- "executionTimestamp": 0,
- "endpoint": "string",
- "retryNr": 0,
- "callId": "string",
- "eventName": "string",
- "requestHeaders": "string",
- "requestSent": "string",
- "requestSentTableColumn": "string",
- "requestFileStoreId": "string",
- "httpResponseCode": 0,
- "httpResponseReason": "string",
- "httpResponseHeaders": "string",
- "responseFromServer": "string",
- "responseFromServerTableColumn": "string",
- "responseMimeType": "string",
- "responseFileStoreId": "string"
}
]
}
Creates the given entity in the system. The id of the entity can not be set for create operation, a new one is generated.
The entity to create
$_type | string Default: "WebhookRegistration" Value: "WebhookRegistration" |
id | string Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway. |
creationTimestamp | integer <int64> Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
modificationTimestamp | integer <int64> Timestamp of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
version | integer <int64> Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted. |
accountId | string Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
name | string Name of the webhook registration. Maximum length of 250 characters. Can not be omitted. |
status | string (ERegistrationStatus) Enum: "ACTIVE" "INACTIVE" "INACTIVE_UNAVAILABLE" enum-descriptions: ["ACTIVE: Registration is active","INACTIVE: Registration is not active","INACTIVE_UNAVAILABLE: Registration is not active, because it is unavailable"] Possible Webhook Registration Status |
description | string Description of the webhook registration. Maximum length of 500 characters. Can be omitted. |
endpoint | string The endpoint url of the webhook registration. To this url the requests for the webhook events are done. Maximum length of 4000 characters. Can be omitted, but should not. |
apiVersion | string (EWebApiVersion) Enum: "V1" "V2" "V3" enum-descriptions: ["V1: Version 1 of the Web-API. Introduced with Unblu 4.x.","V2: Version 2 of the Web-API. Introduced with Unblu 5.","V3: Version 3 of the Web-API. Introduced with Unblu 6."] Version of the Web-API. Version of API corresponds to a path element of the request URL. E.g.: /rest/v3/<service>/... |
secret | string A secret which is send with each webhook event. Maximum length of 4000 characters. Can be omitted. |
events | Array of strings Events for which the webhook endpoint is called, if they occur. Can not be omitted. Check the Webhook Events for possible values. |
{- "$_type": "WebhookRegistration",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "name": "string",
- "status": "ACTIVE",
- "description": "string",
- "endpoint": "string",
- "apiVersion": "V1",
- "secret": "string",
- "events": [
- "string"
]
}
{- "$_type": "WebhookRegistration",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "name": "string",
- "status": "ACTIVE",
- "description": "string",
- "endpoint": "string",
- "apiVersion": "V1",
- "secret": "string",
- "events": [
- "string"
]
}
{- "$_type": "AccountModificationEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "action": "CREATE",
- "entity": {
- "$_type": "Account",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "name": "string",
- "billingAddress": "string",
- "contactAddress": "string",
- "avatar": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}
}, - "editingUser": {
- "$_type": "UserInfo",
- "userId": "string",
- "userName": "string",
- "firstName": "string",
- "lastName": "string",
- "displayName": "string"
}
}
Deletes the entity for the given id
id | string The id of the entity which should be deleted |
{- "$_type": "Error",
- "statusCode": 0,
- "statusDescription": "string",
- "errorMessage": "string"
}
Returns the webhook registration for the given name.
name | string |
{- "$_type": "WebhookRegistration",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "name": "string",
- "status": "ACTIVE",
- "description": "string",
- "endpoint": "string",
- "apiVersion": "V1",
- "secret": "string",
- "events": [
- "string"
]
}
Sends a "ping" webhook to the endpoint of the given registration.
id | string Id of the registration to send the ping webhook to. |
Send a ping event for the given Webhook registration
{- "id": "r1acbAidia_35-tB4o7FbWR"
}
{- "$_type": "Error",
- "statusCode": 0,
- "statusDescription": "string",
- "errorMessage": "string"
}
Returns the entity for the given id
id | string Id of the entity which should be returned |
{- "$_type": "WebhookRegistration",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "name": "string",
- "status": "ACTIVE",
- "description": "string",
- "endpoint": "string",
- "apiVersion": "V1",
- "secret": "string",
- "events": [
- "string"
]
}
Gets a list of entities for the given id's
The id's for which the entities should be fetched
[- "string"
]
[- {
- "$_type": "WebhookRegistration",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "name": "string",
- "status": "ACTIVE",
- "description": "string",
- "endpoint": "string",
- "apiVersion": "V1",
- "secret": "string",
- "events": [
- "string"
]
}
]
Search for webhook registrations in the current account
$_type | string Default: "WebhookRegistrationQuery" Value: "WebhookRegistrationQuery" |
Array of any (WebhookRegistrationSearchFilter) [ items ] List of filters to narrow the search of entities | |
Array of objects (WebhookRegistrationOrderBy) [ items ] List of criteria to order the search result list | |
offset | integer <int32> Offset position in the result set to start pagination |
limit | integer <int32> Maximal amount of items returned |
{- "$_type": "WebhookRegistrationQuery",
- "searchFilters": [
- {
- "$_type": "CreationTimestampWebhookRegistrationSearchFilter",
- "field": "NAME",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
], - "orderBy": [
- {
- "$_type": "WebhookRegistrationOrderBy",
- "field": "ID",
- "order": "ASCENDING"
}
], - "offset": 0,
- "limit": 0
}
{- "$_type": "WebhookRegistrationResult",
- "hasMoreItems": true,
- "nextOffset": 0,
- "items": [
- {
- "$_type": "WebhookRegistration",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "name": "string",
- "status": "ACTIVE",
- "description": "string",
- "endpoint": "string",
- "apiVersion": "V1",
- "secret": "string",
- "events": [
- "string"
]
}
]
}
Updates the entity in the system with the given entity.
The entity to update
$_type | string Default: "WebhookRegistration" Value: "WebhookRegistration" |
id | string Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway. |
creationTimestamp | integer <int64> Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
modificationTimestamp | integer <int64> Timestamp of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
version | integer <int64> Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted. |
accountId | string Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
name | string Name of the webhook registration. Maximum length of 250 characters. Can not be omitted. |
status | string (ERegistrationStatus) Enum: "ACTIVE" "INACTIVE" "INACTIVE_UNAVAILABLE" enum-descriptions: ["ACTIVE: Registration is active","INACTIVE: Registration is not active","INACTIVE_UNAVAILABLE: Registration is not active, because it is unavailable"] Possible Webhook Registration Status |
description | string Description of the webhook registration. Maximum length of 500 characters. Can be omitted. |
endpoint | string The endpoint url of the webhook registration. To this url the requests for the webhook events are done. Maximum length of 4000 characters. Can be omitted, but should not. |
apiVersion | string (EWebApiVersion) Enum: "V1" "V2" "V3" enum-descriptions: ["V1: Version 1 of the Web-API. Introduced with Unblu 4.x.","V2: Version 2 of the Web-API. Introduced with Unblu 5.","V3: Version 3 of the Web-API. Introduced with Unblu 6."] Version of the Web-API. Version of API corresponds to a path element of the request URL. E.g.: /rest/v3/<service>/... |
secret | string A secret which is send with each webhook event. Maximum length of 4000 characters. Can be omitted. |
events | Array of strings Events for which the webhook endpoint is called, if they occur. Can not be omitted. Check the Webhook Events for possible values. |
{- "$_type": "WebhookRegistration",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "name": "string",
- "status": "ACTIVE",
- "description": "string",
- "endpoint": "string",
- "apiVersion": "V1",
- "secret": "string",
- "events": [
- "string"
]
}
{- "$_type": "WebhookRegistration",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "name": "string",
- "status": "ACTIVE",
- "description": "string",
- "endpoint": "string",
- "apiVersion": "V1",
- "secret": "string",
- "events": [
- "string"
]
}
The following HTTP request body is sent as a POST request on the URL used to register the callback:
$_type | string Default: "BotDialogClosedEvent" Value: "BotDialogClosedEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
dialogToken | string Token for this dialog. It is present in every dialog webhook and must be passed to all Bot Web-API service calls to identify the dialog. |
{- "$_type": "BotDialogClosedEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "dialogToken": "string"
}
The following HTTP request body is sent as a POST request on the URL used to register the callback:
$_type | string Default: "BotDialogCounterpartChanged" Value: "BotDialogCounterpartChanged" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
dialogToken | string Token for this dialog. It is present in every dialog webhook and must be passed to all Bot Web-API service calls to identify the dialog. |
object (PersonData) Representation of a Person (Agent or Visitor). | |
object (PersonData) Representation of a Person (Agent or Visitor). |
{- "$_type": "BotDialogCounterpartChanged",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "dialogToken": "string",
- "oldCounterpartPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "newCounterpartPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}
}
The following HTTP request body is sent as a POST request on the URL used to register the callback:
$_type | string Default: "BotDialogMessageEvent" Value: "BotDialogMessageEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
dialogToken | string Token for this dialog. It is present in every dialog webhook and must be passed to all Bot Web-API service calls to identify the dialog. |
any (MessageData) Base class for all conversation messages. Can be one of |
{- "$_type": "BotDialogMessageEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "dialogToken": "string",
- "conversationMessage": {
- "$_type": "ApprovalRequestMessageData",
- "id": "string",
- "conversationId": "string",
- "externalMessengerChannelId": "string",
- "accountId": "string",
- "senderPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "senderPersonPresenceId": "string",
- "serverTimestamp": 0,
- "sendTimestamp": 0,
- "type": "TEXT",
- "recipientPersonIds": [
- "string"
], - "fallbackText": "string",
- "actionId": "string",
- "sourceId": "string",
- "text": "string",
- "textType": "SIMPLE_TEXT",
- "options": [
- {
- "$_type": "MultichoiceQuestionOption",
- "label": "string",
- "value": "string",
- "primary": true
}
], - "answerStatus": "PENDING"
}
}
The following HTTP request body is sent as a POST request on the URL used to register the callback:
$_type | string Default: "BotDialogMessageStateEvent" Value: "BotDialogMessageStateEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
dialogToken | string Token for this dialog. It is present in every dialog webhook and must be passed to all Bot Web-API service calls to identify the dialog. |
messageId | string The id of the message which state has changed |
state | string (EMessageState) Enum: "DELIVERED" "READ" enum-descriptions: ["DELIVERED: The message was delivered to the recipients","READ: The message was read by the recipients"] The state of a message if it was delivered or read |
botPersonId | string The id if the bot who send the message |
conversationId | string The conversation to which the message belongs to |
{- "$_type": "BotDialogMessageStateEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "dialogToken": "string",
- "messageId": "string",
- "state": "DELIVERED",
- "botPersonId": "string",
- "conversationId": "string"
}
The following HTTP request body is sent as a POST request on the URL used to register the callback:
$_type | string Default: "BotDialogOpenEvent" Value: "BotDialogOpenEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
dialogToken | string Token for this dialog. It is present in every dialog webhook and must be passed to all Bot Web-API service calls to identify the dialog. |
dialogType | string (EBotDialogType) Enum: "ONBOARDING" "REBOARDING" "OFFBOARDING" enum-descriptions: ["ONBOARDING","REBOARDING","OFFBOARDING"] Type of a bot dialog |
object (PersonData) Representation of a Person (Agent or Visitor). | |
object (ConversationData) Metadata information about a conversation |
{- "$_type": "BotDialogOpenEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "dialogToken": "string",
- "dialogType": "ONBOARDING",
- "counterpartPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "conversation": {
- "$_type": "ConversationData",
- "creationTimestamp": 0,
- "endTimestamp": 0,
- "id": "string",
- "accountId": "string",
- "topic": "string",
- "recipient": {
- "$_type": "AccountData",
- "id": "string",
- "displayName": "string",
- "avatar": "string"
}, - "participants": [
- {
- "$_type": "ParticipantData",
- "state": "CREATED",
- "personId": "string",
- "connectedViaExternalMessenger": true,
- "hidden": true,
- "conversationStarred": true
}
], - "assigneePersonId": "string",
- "contextPersonId": "string",
- "state": "CREATED",
- "initialEngagementType": "CHAT_REQUEST",
- "locale": "string",
- "tokboxSessionId": "string",
- "visitorData": "string",
- "conversationTemplateId": "string",
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
], - "externalMessengerChannelId": "string",
- "sourceId": "string",
- "endReason": "ENDED_BY_PARTICIPANT",
- "initialEngagementUrl": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
}
The following HTTP request body is sent as a POST request on the URL used to register the callback:
$_type | string Default: "BotOffboardingOfferEvent" Value: "BotOffboardingOfferEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
offboardingToken | string The unique offboarding token for this bot used to identify this offboarding via the bot web API. |
object (PersonData) Representation of a Person (Agent or Visitor). | |
offboardingReason | string (EOffboardingReason) Enum: "FORWARDED" "PARTICIPANT_LEFT" "REMOVED_AFTER_TIMEOUT" "ONBOARDING_DECLINED" "ONBOARDING_TIMEOUT" "ONBOARDING_IDLE_TIMEOUT" "KICKED" "CONVERSATION_UNASSIGNED" "EXTERNAL_CHANNEL_CLOSED" "CONVERSATION_ENDED" "SOLVED_BY_BOT" "CONVERSATION_REQUEUED" "OTHER" enum-descriptions: ["FORWARDED: Conversation was forwarded to another agent and this agent therefore left the conversation","PARTICIPANT_LEFT: The participant left the conversation by himself","REMOVED_AFTER_TIMEOUT: The participant was removed from the conversation as he had a connection timeout","ONBOARDING_DECLINED: The onboarding was declined and therefore the participant will not join the conversation","ONBOARDING_TIMEOUT: The onboarding took too long and therefore the participant will not join the conversation","ONBOARDING_IDLE_TIMEOUT: The onboarding timed out and therefore the participant will not join the conversation","KICKED: The participant was kicked out of the conversation","CONVERSATION_UNASSIGNED: The conversation is no longer assigned to an agent and therefore all other agents were removed","EXTERNAL_CHANNEL_CLOSED: The external channel connected to this conversation has closed, no further messages are possible.","CONVERSATION_ENDED: The conversation has ended","SOLVED_BY_BOT: The conversation was ended because an onboarding bot solved it.","CONVERSATION_REQUEUED: The conversation has been re-queued.","OTHER: Some other unspecified reason"] Reason why the offboarding from a conversation was triggered for an individual person. |
object (ConversationData) Metadata information about a conversation |
{- "$_type": "BotOffboardingOfferEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "offboardingToken": "string",
- "offboardingPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "offboardingReason": "FORWARDED",
- "conversation": {
- "$_type": "ConversationData",
- "creationTimestamp": 0,
- "endTimestamp": 0,
- "id": "string",
- "accountId": "string",
- "topic": "string",
- "recipient": {
- "$_type": "AccountData",
- "id": "string",
- "displayName": "string",
- "avatar": "string"
}, - "participants": [
- {
- "$_type": "ParticipantData",
- "state": "CREATED",
- "personId": "string",
- "connectedViaExternalMessenger": true,
- "hidden": true,
- "conversationStarred": true
}
], - "assigneePersonId": "string",
- "contextPersonId": "string",
- "state": "CREATED",
- "initialEngagementType": "CHAT_REQUEST",
- "locale": "string",
- "tokboxSessionId": "string",
- "visitorData": "string",
- "conversationTemplateId": "string",
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
], - "externalMessengerChannelId": "string",
- "sourceId": "string",
- "endReason": "ENDED_BY_PARTICIPANT",
- "initialEngagementUrl": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
}
The following HTTP request body is sent as a POST request on the URL used to register the callback:
$_type | string Default: "BotOnboardingOfferEvent" Value: "BotOnboardingOfferEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
onboardingToken | string The unique onboarding token for this bot used to identify this onboarding via the bot web API. |
object (PersonData) Representation of a Person (Agent or Visitor). | |
object (ConversationData) Metadata information about a conversation |
{- "$_type": "BotOnboardingOfferEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "onboardingToken": "string",
- "onboardingPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "conversation": {
- "$_type": "ConversationData",
- "creationTimestamp": 0,
- "endTimestamp": 0,
- "id": "string",
- "accountId": "string",
- "topic": "string",
- "recipient": {
- "$_type": "AccountData",
- "id": "string",
- "displayName": "string",
- "avatar": "string"
}, - "participants": [
- {
- "$_type": "ParticipantData",
- "state": "CREATED",
- "personId": "string",
- "connectedViaExternalMessenger": true,
- "hidden": true,
- "conversationStarred": true
}
], - "assigneePersonId": "string",
- "contextPersonId": "string",
- "state": "CREATED",
- "initialEngagementType": "CHAT_REQUEST",
- "locale": "string",
- "tokboxSessionId": "string",
- "visitorData": "string",
- "conversationTemplateId": "string",
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
], - "externalMessengerChannelId": "string",
- "sourceId": "string",
- "endReason": "ENDED_BY_PARTICIPANT",
- "initialEngagementUrl": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
}
The following HTTP request body is sent as a POST request on the URL used to register the callback:
$_type | string Default: "BotReboardingOfferEvent" Value: "BotReboardingOfferEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
reboardingToken | string The token reboarding token for this bot used to identify this reboarding via the bot web API. |
object (PersonData) Representation of a Person (Agent or Visitor). | |
object (ConversationData) Metadata information about a conversation |
{- "$_type": "BotReboardingOfferEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "reboardingToken": "string",
- "reboardingPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "conversation": {
- "$_type": "ConversationData",
- "creationTimestamp": 0,
- "endTimestamp": 0,
- "id": "string",
- "accountId": "string",
- "topic": "string",
- "recipient": {
- "$_type": "AccountData",
- "id": "string",
- "displayName": "string",
- "avatar": "string"
}, - "participants": [
- {
- "$_type": "ParticipantData",
- "state": "CREATED",
- "personId": "string",
- "connectedViaExternalMessenger": true,
- "hidden": true,
- "conversationStarred": true
}
], - "assigneePersonId": "string",
- "contextPersonId": "string",
- "state": "CREATED",
- "initialEngagementType": "CHAT_REQUEST",
- "locale": "string",
- "tokboxSessionId": "string",
- "visitorData": "string",
- "conversationTemplateId": "string",
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
], - "externalMessengerChannelId": "string",
- "sourceId": "string",
- "endReason": "ENDED_BY_PARTICIPANT",
- "initialEngagementUrl": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
}
The following HTTP request body is sent as a POST request on the URL used to register the callback:
$_type | string Default: "ExternalMessengerMessageStateEvent" Value: "ExternalMessengerMessageStateEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
messageId | string The id of the message which state has changed |
state | string (EMessageState) Enum: "DELIVERED" "READ" enum-descriptions: ["DELIVERED: The message was delivered to the recipients","READ: The message was read by the recipients"] The state of a message if it was delivered or read |
sourceId | string The source id of the message |
externalMessengerChannelId | string The id if the external messenger channel |
conversationId | string The conversation to which the message belongs to |
{- "$_type": "ExternalMessengerMessageStateEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "messageId": "string",
- "state": "DELIVERED",
- "sourceId": "string",
- "externalMessengerChannelId": "string",
- "conversationId": "string"
}
The following HTTP request body is sent as a POST request on the URL used to register the callback:
$_type | string Default: "ExternalMessengerNewMessageEvent" Value: "ExternalMessengerNewMessageEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
any (MessageData) Base class for all conversation messages. Can be one of |
{- "$_type": "ExternalMessengerNewMessageEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "conversationMessage": {
- "$_type": "ApprovalRequestMessageData",
- "id": "string",
- "conversationId": "string",
- "externalMessengerChannelId": "string",
- "accountId": "string",
- "senderPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "senderPersonPresenceId": "string",
- "serverTimestamp": 0,
- "sendTimestamp": 0,
- "type": "TEXT",
- "recipientPersonIds": [
- "string"
], - "fallbackText": "string",
- "actionId": "string",
- "sourceId": "string",
- "text": "string",
- "textType": "SIMPLE_TEXT",
- "options": [
- {
- "$_type": "MultichoiceQuestionOption",
- "label": "string",
- "value": "string",
- "primary": true
}
], - "answerStatus": "PENDING"
}
}
The following HTTP request body is sent as a POST request on the URL used to register the callback:
$_type | string Default: "AccountModificationEvent" Value: "AccountModificationEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
action | string (EntityModificationAction) Enum: "CREATE" "UPDATE" "DELETE" enum-descriptions: ["CREATE: Entity was created","UPDATE: Entity was updated","DELETE: Entity was deleted"] Type of modification of an entity |
object (Account) Model of an account. The contact and the billing address can be directly resolved when using the expand feature. | |
object (UserInfo) User information which are normally used together with webhook events. |
{- "$_type": "AccountModificationEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "action": "CREATE",
- "entity": {
- "$_type": "Account",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "name": "string",
- "billingAddress": "string",
- "contactAddress": "string",
- "avatar": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}
}, - "editingUser": {
- "$_type": "UserInfo",
- "userId": "string",
- "userName": "string",
- "firstName": "string",
- "lastName": "string",
- "displayName": "string"
}
}
The following HTTP request body is sent as a POST request on the URL used to register the callback:
$_type | string Default: "AgentForwardingCreatedEvent" Value: "AgentForwardingCreatedEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
invitationId | string Id of the invitation |
conversationId | string Id of the conversation |
token | string Token (digits for pin or character sequence) requested to redeem or revoke the invitation |
dateCreated | integer <int64> Unix timestamp when the event was created |
creatorType | string (EInvitationCreatorType) Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR" enum-descriptions: ["WEB_API: Invitation created with the API","SYSTEM: Invitation created by the system","AGENT: Invitation created by an agent","VISITOR: Invitation created by a visitor"] The type of the person/system who created an invitation |
object (PersonData) Representation of a Person (Agent or Visitor). | |
object (ContextPersonInfo) Information about the context person of a conversation. Normally send together with webhook events. | |
any (AgentTargetData) Target of an 'agent forwarding' or an 'agent invitation' event which can be the agent directly (as | |
comment | string Text provided by the creator for the target |
Array of objects (ConversationLink) [ items ] List of links that can be used to accept the accept forwarding event with the token. |
{- "$_type": "AgentForwardingCreatedEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "invitationId": "string",
- "conversationId": "string",
- "token": "string",
- "dateCreated": 0,
- "creatorType": "WEB_API",
- "creatorPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "contextPersonInfo": {
- "$_type": "ContextPersonInfo",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "osName": "string",
- "osVersion": "string",
- "browserName": "string",
- "browserVersion": "string",
- "locale": "string",
- "city": "string",
- "country": "string"
}, - "target": {
- "$_type": "TeamData",
- "id": "string",
- "accountId": "string",
- "displayName": "string",
- "avatar": "string",
- "parentId": "string"
}, - "comment": "string",
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
]
}
The following HTTP request body is sent as a POST request on the URL used to register the callback:
$_type | string Default: "AgentForwardingRedeemedEvent" Value: "AgentForwardingRedeemedEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
invitationId | string Id of the invitation |
conversationId | string Id of the conversation |
token | string Token (digits for pin or character sequence) requested to redeem or revoke the invitation |
dateCreated | integer <int64> Unix timestamp when the event was created |
creatorType | string (EInvitationCreatorType) Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR" enum-descriptions: ["WEB_API: Invitation created with the API","SYSTEM: Invitation created by the system","AGENT: Invitation created by an agent","VISITOR: Invitation created by a visitor"] The type of the person/system who created an invitation |
object (PersonData) Representation of a Person (Agent or Visitor). | |
object (ContextPersonInfo) Information about the context person of a conversation. Normally send together with webhook events. | |
any (AgentTargetData) Target of an 'agent forwarding' or an 'agent invitation' event which can be the agent directly (as | |
comment | string Text provided by the creator for the target |
object (PersonData) Representation of a Person (Agent or Visitor). |
{- "$_type": "AgentForwardingRedeemedEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "invitationId": "string",
- "conversationId": "string",
- "token": "string",
- "dateCreated": 0,
- "creatorType": "WEB_API",
- "creatorPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "contextPersonInfo": {
- "$_type": "ContextPersonInfo",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "osName": "string",
- "osVersion": "string",
- "browserName": "string",
- "browserVersion": "string",
- "locale": "string",
- "city": "string",
- "country": "string"
}, - "target": {
- "$_type": "TeamData",
- "id": "string",
- "accountId": "string",
- "displayName": "string",
- "avatar": "string",
- "parentId": "string"
}, - "comment": "string",
- "redeemingPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}
}
The following HTTP request body is sent as a POST request on the URL used to register the callback:
$_type | string Default: "AgentForwardingRevokedEvent" Value: "AgentForwardingRevokedEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
invitationId | string Id of the invitation |
conversationId | string Id of the conversation |
token | string Token (digits for pin or character sequence) requested to redeem or revoke the invitation |
dateCreated | integer <int64> Unix timestamp when the event was created |
creatorType | string (EInvitationCreatorType) Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR" enum-descriptions: ["WEB_API: Invitation created with the API","SYSTEM: Invitation created by the system","AGENT: Invitation created by an agent","VISITOR: Invitation created by a visitor"] The type of the person/system who created an invitation |
object (PersonData) Representation of a Person (Agent or Visitor). | |
object (ContextPersonInfo) Information about the context person of a conversation. Normally send together with webhook events. | |
any (AgentTargetData) Target of an 'agent forwarding' or an 'agent invitation' event which can be the agent directly (as | |
comment | string Text provided by the creator for the target |
{- "$_type": "AgentForwardingRevokedEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "invitationId": "string",
- "conversationId": "string",
- "token": "string",
- "dateCreated": 0,
- "creatorType": "WEB_API",
- "creatorPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "contextPersonInfo": {
- "$_type": "ContextPersonInfo",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "osName": "string",
- "osVersion": "string",
- "browserName": "string",
- "browserVersion": "string",
- "locale": "string",
- "city": "string",
- "country": "string"
}, - "target": {
- "$_type": "TeamData",
- "id": "string",
- "accountId": "string",
- "displayName": "string",
- "avatar": "string",
- "parentId": "string"
}, - "comment": "string"
}
The following HTTP request body is sent as a POST request on the URL used to register the callback:
$_type | string Default: "AgentInvitationCreatedEvent" Value: "AgentInvitationCreatedEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
invitationId | string Id of the invitation |
conversationId | string Id of the conversation |
token | string Token (digits for pin or character sequence) requested to redeem or revoke the invitation |
dateCreated | integer <int64> Unix timestamp when the event was created |
creatorType | string (EInvitationCreatorType) Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR" enum-descriptions: ["WEB_API: Invitation created with the API","SYSTEM: Invitation created by the system","AGENT: Invitation created by an agent","VISITOR: Invitation created by a visitor"] The type of the person/system who created an invitation |
object (PersonData) Representation of a Person (Agent or Visitor). | |
object (ContextPersonInfo) Information about the context person of a conversation. Normally send together with webhook events. | |
any (AgentTargetData) Target of an 'agent forwarding' or an 'agent invitation' event which can be the agent directly (as | |
comment | string Text provided by the creator for the target |
Array of objects (ConversationLink) [ items ] List of links that can be used to accept the agent invitation event with the token. |
{- "$_type": "AgentInvitationCreatedEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "invitationId": "string",
- "conversationId": "string",
- "token": "string",
- "dateCreated": 0,
- "creatorType": "WEB_API",
- "creatorPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "contextPersonInfo": {
- "$_type": "ContextPersonInfo",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "osName": "string",
- "osVersion": "string",
- "browserName": "string",
- "browserVersion": "string",
- "locale": "string",
- "city": "string",
- "country": "string"
}, - "target": {
- "$_type": "TeamData",
- "id": "string",
- "accountId": "string",
- "displayName": "string",
- "avatar": "string",
- "parentId": "string"
}, - "comment": "string",
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
]
}
The following HTTP request body is sent as a POST request on the URL used to register the callback:
$_type | string Default: "AgentInvitationRedeemedEvent" Value: "AgentInvitationRedeemedEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
invitationId | string Id of the invitation |
conversationId | string Id of the conversation |
token | string Token (digits for pin or character sequence) requested to redeem or revoke the invitation |
dateCreated | integer <int64> Unix timestamp when the event was created |
creatorType | string (EInvitationCreatorType) Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR" enum-descriptions: ["WEB_API: Invitation created with the API","SYSTEM: Invitation created by the system","AGENT: Invitation created by an agent","VISITOR: Invitation created by a visitor"] The type of the person/system who created an invitation |
object (PersonData) Representation of a Person (Agent or Visitor). | |
object (ContextPersonInfo) Information about the context person of a conversation. Normally send together with webhook events. | |
any (AgentTargetData) Target of an 'agent forwarding' or an 'agent invitation' event which can be the agent directly (as | |
comment | string Text provided by the creator for the target |
object (PersonData) Representation of a Person (Agent or Visitor). |
{- "$_type": "AgentInvitationRedeemedEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "invitationId": "string",
- "conversationId": "string",
- "token": "string",
- "dateCreated": 0,
- "creatorType": "WEB_API",
- "creatorPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "contextPersonInfo": {
- "$_type": "ContextPersonInfo",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "osName": "string",
- "osVersion": "string",
- "browserName": "string",
- "browserVersion": "string",
- "locale": "string",
- "city": "string",
- "country": "string"
}, - "target": {
- "$_type": "TeamData",
- "id": "string",
- "accountId": "string",
- "displayName": "string",
- "avatar": "string",
- "parentId": "string"
}, - "comment": "string",
- "redeemingPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}
}
The following HTTP request body is sent as a POST request on the URL used to register the callback:
$_type | string Default: "AgentInvitationRevokedEvent" Value: "AgentInvitationRevokedEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
invitationId | string Id of the invitation |
conversationId | string Id of the conversation |
token | string Token (digits for pin or character sequence) requested to redeem or revoke the invitation |
dateCreated | integer <int64> Unix timestamp when the event was created |
creatorType | string (EInvitationCreatorType) Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR" enum-descriptions: ["WEB_API: Invitation created with the API","SYSTEM: Invitation created by the system","AGENT: Invitation created by an agent","VISITOR: Invitation created by a visitor"] The type of the person/system who created an invitation |
object (PersonData) Representation of a Person (Agent or Visitor). | |
object (ContextPersonInfo) Information about the context person of a conversation. Normally send together with webhook events. | |
any (AgentTargetData) Target of an 'agent forwarding' or an 'agent invitation' event which can be the agent directly (as | |
comment | string Text provided by the creator for the target |
{- "$_type": "AgentInvitationRevokedEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "invitationId": "string",
- "conversationId": "string",
- "token": "string",
- "dateCreated": 0,
- "creatorType": "WEB_API",
- "creatorPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "contextPersonInfo": {
- "$_type": "ContextPersonInfo",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "osName": "string",
- "osVersion": "string",
- "browserName": "string",
- "browserVersion": "string",
- "locale": "string",
- "city": "string",
- "country": "string"
}, - "target": {
- "$_type": "TeamData",
- "id": "string",
- "accountId": "string",
- "displayName": "string",
- "avatar": "string",
- "parentId": "string"
}, - "comment": "string"
}
The following HTTP request body is sent as a POST request on the URL used to register the callback:
$_type | string Default: "ApiKeyModificationEvent" Value: "ApiKeyModificationEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
action | string (EntityModificationAction) Enum: "CREATE" "UPDATE" "DELETE" enum-descriptions: ["CREATE: Entity was created","UPDATE: Entity was updated","DELETE: Entity was deleted"] Type of modification of an entity |
object (ApiKey) Model of an ApiKey. Api keys identify the usage of unblu to a certain account. There can be multiple api keys per account to define different configurations | |
object (UserInfo) User information which are normally used together with webhook events. |
{- "$_type": "ApiKeyModificationEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "action": "CREATE",
- "entity": {
- "$_type": "ApiKey",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "apiKey": "string",
- "name": "string",
- "description": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "editingUser": {
- "$_type": "UserInfo",
- "userId": "string",
- "userName": "string",
- "firstName": "string",
- "lastName": "string",
- "displayName": "string"
}
}
The following HTTP request body is sent as a POST request on the URL used to register the callback:
$_type | string Default: "AssignmentRequestCreatedEvent" Value: "AssignmentRequestCreatedEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
invitationId | string Id of the invitation |
conversationId | string Id of the conversation |
token | string Token (digits for pin or character sequence) requested to redeem or revoke the invitation |
dateCreated | integer <int64> Unix timestamp when the event was created |
creatorType | string (EInvitationCreatorType) Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR" enum-descriptions: ["WEB_API: Invitation created with the API","SYSTEM: Invitation created by the system","AGENT: Invitation created by an agent","VISITOR: Invitation created by a visitor"] The type of the person/system who created an invitation |
object (PersonData) Representation of a Person (Agent or Visitor). | |
object (ContextPersonInfo) Information about the context person of a conversation. Normally send together with webhook events. | |
any (ConversationRecipientData) Recipient of a conversation: Either a single | |
Array of objects (ConversationLink) [ items ] List of links that can be used to accept the assignment request event with the token. | |
initialEngagementUrl | string The URL where the visitor originating the conversation was. Only available for conversations originated by a visitor where Unblu was integrated in the customers website. e.g. conversations initiated from the mobile SDK won't have an initial engagement URL. |
{- "$_type": "AssignmentRequestCreatedEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "invitationId": "string",
- "conversationId": "string",
- "token": "string",
- "dateCreated": 0,
- "creatorType": "WEB_API",
- "creatorPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "contextPersonInfo": {
- "$_type": "ContextPersonInfo",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "osName": "string",
- "osVersion": "string",
- "browserName": "string",
- "browserVersion": "string",
- "locale": "string",
- "city": "string",
- "country": "string"
}, - "target": {
- "$_type": "AccountData",
- "id": "string",
- "displayName": "string",
- "avatar": "string"
}, - "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
], - "initialEngagementUrl": "string"
}
The following HTTP request body is sent as a POST request on the URL used to register the callback:
$_type | string Default: "AssignmentRequestRedeemedEvent" Value: "AssignmentRequestRedeemedEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
invitationId | string Id of the invitation |
conversationId | string Id of the conversation |
token | string Token (digits for pin or character sequence) requested to redeem or revoke the invitation |
dateCreated | integer <int64> Unix timestamp when the event was created |
creatorType | string (EInvitationCreatorType) Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR" enum-descriptions: ["WEB_API: Invitation created with the API","SYSTEM: Invitation created by the system","AGENT: Invitation created by an agent","VISITOR: Invitation created by a visitor"] The type of the person/system who created an invitation |
object (PersonData) Representation of a Person (Agent or Visitor). | |
object (ContextPersonInfo) Information about the context person of a conversation. Normally send together with webhook events. | |
any (ConversationRecipientData) Recipient of a conversation: Either a single | |
object (PersonData) Representation of a Person (Agent or Visitor). |
{- "$_type": "AssignmentRequestRedeemedEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "invitationId": "string",
- "conversationId": "string",
- "token": "string",
- "dateCreated": 0,
- "creatorType": "WEB_API",
- "creatorPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "contextPersonInfo": {
- "$_type": "ContextPersonInfo",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "osName": "string",
- "osVersion": "string",
- "browserName": "string",
- "browserVersion": "string",
- "locale": "string",
- "city": "string",
- "country": "string"
}, - "target": {
- "$_type": "AccountData",
- "id": "string",
- "displayName": "string",
- "avatar": "string"
}, - "redeemingPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}
}
The following HTTP request body is sent as a POST request on the URL used to register the callback:
$_type | string Default: "AssignmentRequestRevokedEvent" Value: "AssignmentRequestRevokedEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
invitationId | string Id of the invitation |
conversationId | string Id of the conversation |
token | string Token (digits for pin or character sequence) requested to redeem or revoke the invitation |
dateCreated | integer <int64> Unix timestamp when the event was created |
creatorType | string (EInvitationCreatorType) Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR" enum-descriptions: ["WEB_API: Invitation created with the API","SYSTEM: Invitation created by the system","AGENT: Invitation created by an agent","VISITOR: Invitation created by a visitor"] The type of the person/system who created an invitation |
object (PersonData) Representation of a Person (Agent or Visitor). | |
object (ContextPersonInfo) Information about the context person of a conversation. Normally send together with webhook events. | |
any (ConversationRecipientData) Recipient of a conversation: Either a single |
{- "$_type": "AssignmentRequestRevokedEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "invitationId": "string",
- "conversationId": "string",
- "token": "string",
- "dateCreated": 0,
- "creatorType": "WEB_API",
- "creatorPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "contextPersonInfo": {
- "$_type": "ContextPersonInfo",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "osName": "string",
- "osVersion": "string",
- "browserName": "string",
- "browserVersion": "string",
- "locale": "string",
- "city": "string",
- "country": "string"
}, - "target": {
- "$_type": "AccountData",
- "id": "string",
- "displayName": "string",
- "avatar": "string"
}
}
The following HTTP request body is sent as a POST request on the URL used to register the callback:
$_type | string Default: "ConversationCreatedEvent" Value: "ConversationCreatedEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
object (ConversationData) Metadata information about a conversation |
{- "$_type": "ConversationCreatedEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "conversation": {
- "$_type": "ConversationData",
- "creationTimestamp": 0,
- "endTimestamp": 0,
- "id": "string",
- "accountId": "string",
- "topic": "string",
- "recipient": {
- "$_type": "AccountData",
- "id": "string",
- "displayName": "string",
- "avatar": "string"
}, - "participants": [
- {
- "$_type": "ParticipantData",
- "state": "CREATED",
- "personId": "string",
- "connectedViaExternalMessenger": true,
- "hidden": true,
- "conversationStarred": true
}
], - "assigneePersonId": "string",
- "contextPersonId": "string",
- "state": "CREATED",
- "initialEngagementType": "CHAT_REQUEST",
- "locale": "string",
- "tokboxSessionId": "string",
- "visitorData": "string",
- "conversationTemplateId": "string",
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
], - "externalMessengerChannelId": "string",
- "sourceId": "string",
- "endReason": "ENDED_BY_PARTICIPANT",
- "initialEngagementUrl": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
}
The following HTTP request body is sent as a POST request on the URL used to register the callback:
$_type | string Default: "ConversationEndedEvent" Value: "ConversationEndedEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
object (ConversationData) Metadata information about a conversation |
{- "$_type": "ConversationEndedEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "conversation": {
- "$_type": "ConversationData",
- "creationTimestamp": 0,
- "endTimestamp": 0,
- "id": "string",
- "accountId": "string",
- "topic": "string",
- "recipient": {
- "$_type": "AccountData",
- "id": "string",
- "displayName": "string",
- "avatar": "string"
}, - "participants": [
- {
- "$_type": "ParticipantData",
- "state": "CREATED",
- "personId": "string",
- "connectedViaExternalMessenger": true,
- "hidden": true,
- "conversationStarred": true
}
], - "assigneePersonId": "string",
- "contextPersonId": "string",
- "state": "CREATED",
- "initialEngagementType": "CHAT_REQUEST",
- "locale": "string",
- "tokboxSessionId": "string",
- "visitorData": "string",
- "conversationTemplateId": "string",
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
], - "externalMessengerChannelId": "string",
- "sourceId": "string",
- "endReason": "ENDED_BY_PARTICIPANT",
- "initialEngagementUrl": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
}
The following HTTP request body is sent as a POST request on the URL used to register the callback:
$_type | string Default: "ConversationMessageStateEvent" Value: "ConversationMessageStateEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
messageId | string The id of the message which state has changed |
state | string (EMessageState) Enum: "DELIVERED" "READ" enum-descriptions: ["DELIVERED: The message was delivered to the recipients","READ: The message was read by the recipients"] The state of a message if it was delivered or read |
conversationId | string The conversation to which the message belongs to |
{- "$_type": "ConversationMessageStateEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "messageId": "string",
- "state": "DELIVERED",
- "conversationId": "string"
}
The following HTTP request body is sent as a POST request on the URL used to register the callback:
$_type | string Default: "ConversationNewMessageEvent" Value: "ConversationNewMessageEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
any (MessageData) Base class for all conversation messages. Can be one of |
{- "$_type": "ConversationNewMessageEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "conversationMessage": {
- "$_type": "ApprovalRequestMessageData",
- "id": "string",
- "conversationId": "string",
- "externalMessengerChannelId": "string",
- "accountId": "string",
- "senderPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "senderPersonPresenceId": "string",
- "serverTimestamp": 0,
- "sendTimestamp": 0,
- "type": "TEXT",
- "recipientPersonIds": [
- "string"
], - "fallbackText": "string",
- "actionId": "string",
- "sourceId": "string",
- "text": "string",
- "textType": "SIMPLE_TEXT",
- "options": [
- {
- "$_type": "MultichoiceQuestionOption",
- "label": "string",
- "value": "string",
- "primary": true
}
], - "answerStatus": "PENDING"
}
}
The following HTTP request body is sent as a POST request on the URL used to register the callback:
$_type | string Default: "ConversationUpdatedEvent" Value: "ConversationUpdatedEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
object (ConversationData) Metadata information about a conversation |
{- "$_type": "ConversationUpdatedEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "conversation": {
- "$_type": "ConversationData",
- "creationTimestamp": 0,
- "endTimestamp": 0,
- "id": "string",
- "accountId": "string",
- "topic": "string",
- "recipient": {
- "$_type": "AccountData",
- "id": "string",
- "displayName": "string",
- "avatar": "string"
}, - "participants": [
- {
- "$_type": "ParticipantData",
- "state": "CREATED",
- "personId": "string",
- "connectedViaExternalMessenger": true,
- "hidden": true,
- "conversationStarred": true
}
], - "assigneePersonId": "string",
- "contextPersonId": "string",
- "state": "CREATED",
- "initialEngagementType": "CHAT_REQUEST",
- "locale": "string",
- "tokboxSessionId": "string",
- "visitorData": "string",
- "conversationTemplateId": "string",
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
], - "externalMessengerChannelId": "string",
- "sourceId": "string",
- "endReason": "ENDED_BY_PARTICIPANT",
- "initialEngagementUrl": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
}
The following HTTP request body is sent as a POST request on the URL used to register the callback:
$_type | string Default: "DomainModificationEvent" Value: "DomainModificationEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
action | string (EntityModificationAction) Enum: "CREATE" "UPDATE" "DELETE" enum-descriptions: ["CREATE: Entity was created","UPDATE: Entity was updated","DELETE: Entity was deleted"] Type of modification of an entity |
object (Domain) Model of a domain | |
object (UserInfo) User information which are normally used together with webhook events. |
{- "$_type": "DomainModificationEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "action": "CREATE",
- "entity": {
- "$_type": "Domain",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "domainName": "string"
}, - "editingUser": {
- "$_type": "UserInfo",
- "userId": "string",
- "userName": "string",
- "firstName": "string",
- "lastName": "string",
- "displayName": "string"
}
}
The following HTTP request body is sent as a POST request on the URL used to register the callback:
$_type | string Default: "NamedAreaModificationEvent" Value: "NamedAreaModificationEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
action | string (EntityModificationAction) Enum: "CREATE" "UPDATE" "DELETE" enum-descriptions: ["CREATE: Entity was created","UPDATE: Entity was updated","DELETE: Entity was deleted"] Type of modification of an entity |
object (NamedArea) Model of named areas. They can either be domains or meta tags | |
object (UserInfo) User information which are normally used together with webhook events. |
{- "$_type": "NamedAreaModificationEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "action": "CREATE",
- "entity": {
- "$_type": "NamedArea",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "avatar": "string",
- "name": "string",
- "description": "string",
- "type": "META_TAG",
- "siteId": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "editingUser": {
- "$_type": "UserInfo",
- "userId": "string",
- "userName": "string",
- "firstName": "string",
- "lastName": "string",
- "displayName": "string"
}
}
The following HTTP request body is sent as a POST request on the URL used to register the callback:
$_type | string Default: "PersonModificationEvent" Value: "PersonModificationEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
action | string (EntityModificationAction) Enum: "CREATE" "UPDATE" "DELETE" enum-descriptions: ["CREATE: Entity was created","UPDATE: Entity was updated","DELETE: Entity was deleted"] Type of modification of an entity |
object (PersonData) Representation of a Person (Agent or Visitor). | |
object (UserInfo) User information which are normally used together with webhook events. |
{- "$_type": "PersonModificationEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "action": "CREATE",
- "entity": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "editingUser": {
- "$_type": "UserInfo",
- "userId": "string",
- "userName": "string",
- "firstName": "string",
- "lastName": "string",
- "displayName": "string"
}
}
The following HTTP request body is sent as a POST request on the URL used to register the callback:
$_type | string Default: "PinCreatedEvent" Value: "PinCreatedEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
invitationId | string Id of the invitation |
conversationId | string Id of the conversation |
token | string Token (digits for pin or character sequence) requested to redeem or revoke the invitation |
dateCreated | integer <int64> Unix timestamp when the event was created |
creatorType | string (EInvitationCreatorType) Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR" enum-descriptions: ["WEB_API: Invitation created with the API","SYSTEM: Invitation created by the system","AGENT: Invitation created by an agent","VISITOR: Invitation created by a visitor"] The type of the person/system who created an invitation |
object (PersonData) Representation of a Person (Agent or Visitor). | |
expirationTimestamp | integer <int64> Unix timestamp after witch the invitation is no longer valid |
Array of objects (ConversationLink) [ items ] List of links that can be used to accept the pin event with the token. |
{- "$_type": "PinCreatedEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "invitationId": "string",
- "conversationId": "string",
- "token": "string",
- "dateCreated": 0,
- "creatorType": "WEB_API",
- "creatorPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "expirationTimestamp": 0,
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
]
}
The following HTTP request body is sent as a POST request on the URL used to register the callback:
$_type | string Default: "PinRedeemedEvent" Value: "PinRedeemedEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
invitationId | string Id of the invitation |
conversationId | string Id of the conversation |
token | string Token (digits for pin or character sequence) requested to redeem or revoke the invitation |
dateCreated | integer <int64> Unix timestamp when the event was created |
creatorType | string (EInvitationCreatorType) Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR" enum-descriptions: ["WEB_API: Invitation created with the API","SYSTEM: Invitation created by the system","AGENT: Invitation created by an agent","VISITOR: Invitation created by a visitor"] The type of the person/system who created an invitation |
object (PersonData) Representation of a Person (Agent or Visitor). | |
expirationTimestamp | integer <int64> Unix timestamp after witch the invitation is no longer valid |
object (PersonData) Representation of a Person (Agent or Visitor). |
{- "$_type": "PinRedeemedEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "invitationId": "string",
- "conversationId": "string",
- "token": "string",
- "dateCreated": 0,
- "creatorType": "WEB_API",
- "creatorPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "expirationTimestamp": 0,
- "redeemingPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}
}
The following HTTP request body is sent as a POST request on the URL used to register the callback:
$_type | string Default: "PinRenewedEvent" Value: "PinRenewedEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
invitationId | string Id of the invitation |
conversationId | string Id of the conversation |
token | string Token (digits for pin or character sequence) requested to redeem or revoke the invitation |
dateCreated | integer <int64> Unix timestamp when the event was created |
creatorType | string (EInvitationCreatorType) Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR" enum-descriptions: ["WEB_API: Invitation created with the API","SYSTEM: Invitation created by the system","AGENT: Invitation created by an agent","VISITOR: Invitation created by a visitor"] The type of the person/system who created an invitation |
object (PersonData) Representation of a Person (Agent or Visitor). | |
expirationTimestamp | integer <int64> Unix timestamp after witch the invitation is no longer valid |
Array of objects (ConversationLink) [ items ] List of links that can be used to accept the visitor invitation event with the token. |
{- "$_type": "PinRenewedEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "invitationId": "string",
- "conversationId": "string",
- "token": "string",
- "dateCreated": 0,
- "creatorType": "WEB_API",
- "creatorPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "expirationTimestamp": 0,
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
]
}
The following HTTP request body is sent as a POST request on the URL used to register the callback:
$_type | string Default: "PinRevokedEvent" Value: "PinRevokedEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
invitationId | string Id of the invitation |
conversationId | string Id of the conversation |
token | string Token (digits for pin or character sequence) requested to redeem or revoke the invitation |
dateCreated | integer <int64> Unix timestamp when the event was created |
creatorType | string (EInvitationCreatorType) Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR" enum-descriptions: ["WEB_API: Invitation created with the API","SYSTEM: Invitation created by the system","AGENT: Invitation created by an agent","VISITOR: Invitation created by a visitor"] The type of the person/system who created an invitation |
object (PersonData) Representation of a Person (Agent or Visitor). | |
expirationTimestamp | integer <int64> Unix timestamp after witch the invitation is no longer valid |
{- "$_type": "PinRevokedEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "invitationId": "string",
- "conversationId": "string",
- "token": "string",
- "dateCreated": 0,
- "creatorType": "WEB_API",
- "creatorPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "expirationTimestamp": 0
}
The following HTTP request body is sent as a POST request on the URL used to register the callback:
$_type | string Default: "WebhookPingEvent" Value: "WebhookPingEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
object (WebhookRegistration) Model of a webhook registration. Registered webhooks for certain events are stored inside this model. |
{- "$_type": "WebhookPingEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "webhookConfiguration": {
- "$_type": "WebhookRegistration",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "name": "string",
- "status": "ACTIVE",
- "description": "string",
- "endpoint": "string",
- "apiVersion": "V1",
- "secret": "string",
- "events": [
- "string"
]
}
}
The following HTTP request body is sent as a POST request on the URL used to register the callback:
$_type | string Default: "IncomingCallPushNotificationEvent" Value: "IncomingCallPushNotificationEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
object (PersonData) Representation of a Person (Agent or Visitor). | |
locale | string Locale (as BCP 47 language tag form including region if available) |
conversationId | string Id of the conversation |
deviceTokens | Array of strings List of device tokens |
callState | string (ECallState) Enum: "IDLE" "CALLING" "FORWARDING" "ACTIVE" enum-descriptions: ["IDLE: The call is not active (anymore)","CALLING: The call is ringing, nobody accepted it yet","FORWARDING: The call is ringing for the hidden agents of the conversation, after no visible agent has accepted the call","ACTIVE: The call is active"] State of the call |
callType | string (ECallType) Enum: "AUDIO" "VIDEO" enum-descriptions: ["AUDIO: The call was started as voice call","VIDEO: The call was started as video call"] Type of the call |
callStartTimestamp | integer <int64> Timestamp when the call started |
callerName | string Name of the person calling |
callerPersonId | string Person id of the person calling |
{- "$_type": "IncomingCallPushNotificationEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "recipient": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "locale": "string",
- "conversationId": "string",
- "deviceTokens": [
- "string"
], - "callState": "IDLE",
- "callType": "AUDIO",
- "callStartTimestamp": 0,
- "callerName": "string",
- "callerPersonId": "string"
}
The following HTTP request body is sent as a POST request on the URL used to register the callback:
$_type | string Default: "MissedCallPushNotificationEvent" Value: "MissedCallPushNotificationEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
object (PersonData) Representation of a Person (Agent or Visitor). | |
locale | string Locale (as BCP 47 language tag form including region if available) |
conversationId | string Id of the conversation |
deviceTokens | Array of strings List of device tokens |
callState | string (ECallState) Enum: "IDLE" "CALLING" "FORWARDING" "ACTIVE" enum-descriptions: ["IDLE: The call is not active (anymore)","CALLING: The call is ringing, nobody accepted it yet","FORWARDING: The call is ringing for the hidden agents of the conversation, after no visible agent has accepted the call","ACTIVE: The call is active"] State of the call |
callType | string (ECallType) Enum: "AUDIO" "VIDEO" enum-descriptions: ["AUDIO: The call was started as voice call","VIDEO: The call was started as video call"] Type of the call |
callStartTimestamp | integer <int64> Timestamp when the call started |
callerName | string Name of the person calling |
callerPersonId | string Person ID of the person calling |
callEndReason | string (ECallParticipationEndReason) Enum: "MISSED_BECAUSE_TIMEOUT" "MISSED_BECAUSE_TERMINATED" "TERMINATED_BY_PARTICIPANT" enum-descriptions: ["MISSED_BECAUSE_TIMEOUT: The participation was ended because of a timeout on the participant's side.","MISSED_BECAUSE_TERMINATED: The participation ended because the initiator terminated the call before the other participant answered it.","TERMINATED_BY_PARTICIPANT: The participation ended normally"] Determines the reason why the participation on a call ended. |
{- "$_type": "MissedCallPushNotificationEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "recipient": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "locale": "string",
- "conversationId": "string",
- "deviceTokens": [
- "string"
], - "callState": "IDLE",
- "callType": "AUDIO",
- "callStartTimestamp": 0,
- "callerName": "string",
- "callerPersonId": "string",
- "callEndReason": "MISSED_BECAUSE_TIMEOUT"
}
The following HTTP request body is sent as a POST request on the URL used to register the callback:
$_type | string Default: "NewMessagePushNotificationEvent" Value: "NewMessagePushNotificationEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
object (PersonData) Representation of a Person (Agent or Visitor). | |
locale | string Locale (as BCP 47 language tag form including region if available) |
conversationId | string Id of the conversation |
deviceTokens | Array of strings List of device tokens |
messageId | string Id of the message |
messageText | string Text of the message |
messageSendTimestamp | integer <int64> Timestamp when the message was sent |
messageServerTimestamp | integer <int64> Timestamp when the message was received by the server. |
senderName | string Name of the sender, can be null if the message was sent by the system. |
senderPersonId | string Person id of the sender, can be null if the message was sent by the system. |
notificationCount | integer <int32> Number of notifications (i.e. unread messages) in this conversation |
{- "$_type": "NewMessagePushNotificationEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "recipient": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "locale": "string",
- "conversationId": "string",
- "deviceTokens": [
- "string"
], - "messageId": "string",
- "messageText": "string",
- "messageSendTimestamp": 0,
- "messageServerTimestamp": 0,
- "senderName": "string",
- "senderPersonId": "string",
- "notificationCount": 0
}
The following HTTP request body is sent as a POST request on the URL used to register the callback:
$_type | string Default: "ReadMessagePushNotificationEvent" Value: "ReadMessagePushNotificationEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
object (PersonData) Representation of a Person (Agent or Visitor). | |
locale | string Locale (as BCP 47 language tag form including region if available) |
conversationId | string Id of the conversation |
deviceTokens | Array of strings List of device tokens |
messageId | string Id of the message |
readTimestamp | integer <int64> Timestamp when the message was read. |
notificationCount | integer <int32> Number of notifications (i.e. unread messages) in this conversation |
{- "$_type": "ReadMessagePushNotificationEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "recipient": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "locale": "string",
- "conversationId": "string",
- "deviceTokens": [
- "string"
], - "messageId": "string",
- "readTimestamp": 0,
- "notificationCount": 0
}
The following HTTP request body is sent as a POST request on the URL used to register the callback:
$_type | string Default: "RevokeCallPushNotificationEvent" Value: "RevokeCallPushNotificationEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
object (PersonData) Representation of a Person (Agent or Visitor). | |
locale | string Locale (as BCP 47 language tag form including region if available) |
conversationId | string Id of the conversation |
deviceTokens | Array of strings List of device tokens |
callState | string (ECallState) Enum: "IDLE" "CALLING" "FORWARDING" "ACTIVE" enum-descriptions: ["IDLE: The call is not active (anymore)","CALLING: The call is ringing, nobody accepted it yet","FORWARDING: The call is ringing for the hidden agents of the conversation, after no visible agent has accepted the call","ACTIVE: The call is active"] State of the call |
{- "$_type": "RevokeCallPushNotificationEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "recipient": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "locale": "string",
- "conversationId": "string",
- "deviceTokens": [
- "string"
], - "callState": "IDLE"
}
The following HTTP request body is sent as a POST request on the URL used to register the callback:
$_type | string Default: "TeamModificationEvent" Value: "TeamModificationEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
action | string (EntityModificationAction) Enum: "CREATE" "UPDATE" "DELETE" enum-descriptions: ["CREATE: Entity was created","UPDATE: Entity was updated","DELETE: Entity was deleted"] Type of modification of an entity |
object (Team) Model of a team. A team consist out of multiple users. For each account there is at least the default team. | |
object (UserInfo) User information which are normally used together with webhook events. |
{- "$_type": "TeamModificationEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "action": "CREATE",
- "entity": {
- "$_type": "Team",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "avatar": "string",
- "name": "string",
- "parentId": "string",
- "description": "string",
- "externallyManaged": true,
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "editingUser": {
- "$_type": "UserInfo",
- "userId": "string",
- "userName": "string",
- "firstName": "string",
- "lastName": "string",
- "displayName": "string"
}
}
The following HTTP request body is sent as a POST request on the URL used to register the callback:
$_type | string Default: "UserModificationEvent" Value: "UserModificationEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
action | string (EntityModificationAction) Enum: "CREATE" "UPDATE" "DELETE" enum-descriptions: ["CREATE: Entity was created","UPDATE: Entity was updated","DELETE: Entity was deleted"] Type of modification of an entity |
object (User) Model of a user. A user is normally an agent and/or a person who manages the system | |
object (UserInfo) User information which are normally used together with webhook events. |
{- "$_type": "UserModificationEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "action": "CREATE",
- "entity": {
- "$_type": "User",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "avatar": "string",
- "username": "string",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "authorizationRole": "SUPER_ADMIN",
- "displayName": "string",
- "firstName": "string",
- "lastName": "string",
- "externallyManaged": true,
- "virtualUser": true,
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "editingUser": {
- "$_type": "UserInfo",
- "userId": "string",
- "userName": "string",
- "firstName": "string",
- "lastName": "string",
- "displayName": "string"
}
}
The following HTTP request body is sent as a POST request on the URL used to register the callback:
$_type | string Default: "VisitorInvitationCreatedEvent" Value: "VisitorInvitationCreatedEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
invitationId | string Id of the invitation |
conversationId | string Id of the conversation |
token | string Token (digits for pin or character sequence) requested to redeem or revoke the invitation |
dateCreated | integer <int64> Unix timestamp when the event was created |
creatorType | string (EInvitationCreatorType) Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR" enum-descriptions: ["WEB_API: Invitation created with the API","SYSTEM: Invitation created by the system","AGENT: Invitation created by an agent","VISITOR: Invitation created by a visitor"] The type of the person/system who created an invitation |
object (PersonData) Representation of a Person (Agent or Visitor). | |
string Visitor email | |
nickname | string Visitor nickname |
expirationTimestamp | integer <int64> Unix timestamp after witch the invitation is no longer valid |
Array of objects (ConversationLink) [ items ] List of links that can be used to accept the visitor invitation event with the token. |
{- "$_type": "VisitorInvitationCreatedEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "invitationId": "string",
- "conversationId": "string",
- "token": "string",
- "dateCreated": 0,
- "creatorType": "WEB_API",
- "creatorPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "email": "string",
- "nickname": "string",
- "expirationTimestamp": 0,
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
]
}
The following HTTP request body is sent as a POST request on the URL used to register the callback:
$_type | string Default: "VisitorInvitationRedeemedEvent" Value: "VisitorInvitationRedeemedEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
invitationId | string Id of the invitation |
conversationId | string Id of the conversation |
token | string Token (digits for pin or character sequence) requested to redeem or revoke the invitation |
dateCreated | integer <int64> Unix timestamp when the event was created |
creatorType | string (EInvitationCreatorType) Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR" enum-descriptions: ["WEB_API: Invitation created with the API","SYSTEM: Invitation created by the system","AGENT: Invitation created by an agent","VISITOR: Invitation created by a visitor"] The type of the person/system who created an invitation |
object (PersonData) Representation of a Person (Agent or Visitor). | |
string Visitor email | |
nickname | string Visitor nickname |
expirationTimestamp | integer <int64> Unix timestamp after witch the invitation is no longer valid |
object (PersonData) Representation of a Person (Agent or Visitor). |
{- "$_type": "VisitorInvitationRedeemedEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "invitationId": "string",
- "conversationId": "string",
- "token": "string",
- "dateCreated": 0,
- "creatorType": "WEB_API",
- "creatorPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "email": "string",
- "nickname": "string",
- "expirationTimestamp": 0,
- "redeemingPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}
}
The following HTTP request body is sent as a POST request on the URL used to register the callback:
$_type | string Default: "VisitorInvitationRenewedEvent" Value: "VisitorInvitationRenewedEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
invitationId | string Id of the invitation |
conversationId | string Id of the conversation |
token | string Token (digits for pin or character sequence) requested to redeem or revoke the invitation |
dateCreated | integer <int64> Unix timestamp when the event was created |
creatorType | string (EInvitationCreatorType) Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR" enum-descriptions: ["WEB_API: Invitation created with the API","SYSTEM: Invitation created by the system","AGENT: Invitation created by an agent","VISITOR: Invitation created by a visitor"] The type of the person/system who created an invitation |
object (PersonData) Representation of a Person (Agent or Visitor). | |
string Visitor email | |
nickname | string Visitor nickname |
expirationTimestamp | integer <int64> Unix timestamp after witch the invitation is no longer valid |
Array of objects (ConversationLink) [ items ] List of links that can be used to accept the visitor invitation event with the token. |
{- "$_type": "VisitorInvitationRenewedEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "invitationId": "string",
- "conversationId": "string",
- "token": "string",
- "dateCreated": 0,
- "creatorType": "WEB_API",
- "creatorPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "email": "string",
- "nickname": "string",
- "expirationTimestamp": 0,
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
]
}
The following HTTP request body is sent as a POST request on the URL used to register the callback:
$_type | string Default: "VisitorInvitationRevokedEvent" Value: "VisitorInvitationRevokedEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
invitationId | string Id of the invitation |
conversationId | string Id of the conversation |
token | string Token (digits for pin or character sequence) requested to redeem or revoke the invitation |
dateCreated | integer <int64> Unix timestamp when the event was created |
creatorType | string (EInvitationCreatorType) Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR" enum-descriptions: ["WEB_API: Invitation created with the API","SYSTEM: Invitation created by the system","AGENT: Invitation created by an agent","VISITOR: Invitation created by a visitor"] The type of the person/system who created an invitation |
object (PersonData) Representation of a Person (Agent or Visitor). | |
string Visitor email | |
nickname | string Visitor nickname |
expirationTimestamp | integer <int64> Unix timestamp after witch the invitation is no longer valid |
{- "$_type": "VisitorInvitationRevokedEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "invitationId": "string",
- "conversationId": "string",
- "token": "string",
- "dateCreated": 0,
- "creatorType": "WEB_API",
- "creatorPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "email": "string",
- "nickname": "string",
- "expirationTimestamp": 0
}
$_type | string Default: "Account" Value: "Account" |
id | string Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway. |
creationTimestamp | integer <int64> Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
modificationTimestamp | integer <int64> Timestamp of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
version | integer <int64> Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted. |
name | string The name of the account. Maximum length of 250 characters and can not be empty. |
string or Address (object) expand-query-key: billingAddress type: ExpandableField The id to an address which is used for billing, if the contact address should not be used. Should be null, if only contact address should be used. | |
string or Address (object) expand-query-key: contactAddress type: ExpandableField The id of the contact address for the account. Is also used for billing if no extra billing address is defined. | |
string or Avatar (object) expand-query-key: avatar type: ExpandableField Avatar of the entity: id that can be expanded. | |
object expand-query-key: configuration type: Map The entity's configuration properties. Only contains values when the 'expand' query parameter is used with the value 'configuration'. | |
object expand-query-key: metadata type: Map The entity's metadata properties. Only contains values when the 'expand' query parameter is used with the value 'metadata'. | |
object expand-query-key: text type: Map The entity's text properties. Only contains values when the 'expand' query parameter is used with the value 'text'. |
{- "$_type": "Account",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "name": "string",
- "billingAddress": "string",
- "contactAddress": "string",
- "avatar": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}
}
$_type | string Default: "AccountData" Value: "AccountData" |
id | string Unique id of the account. |
displayName | string Display-Name of the account |
string or Avatar (object) expand-query-key: avatar type: ExpandableField Avatar of the account: id that can be expanded. |
{- "$_type": "AccountData",
- "id": "string",
- "displayName": "string",
- "avatar": "string"
}
$_type | string Default: "AccountModificationEvent" Value: "AccountModificationEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
action | string (EntityModificationAction) Enum: "CREATE" "UPDATE" "DELETE" enum-descriptions: ["CREATE: Entity was created","UPDATE: Entity was updated","DELETE: Entity was deleted"] Type of modification of an entity |
object (Account) Model of an account. The contact and the billing address can be directly resolved when using the expand feature. | |
object (UserInfo) User information which are normally used together with webhook events. |
{- "$_type": "AccountModificationEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "action": "CREATE",
- "entity": {
- "$_type": "Account",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "name": "string",
- "billingAddress": "string",
- "contactAddress": "string",
- "avatar": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}
}, - "editingUser": {
- "$_type": "UserInfo",
- "userId": "string",
- "userName": "string",
- "firstName": "string",
- "lastName": "string",
- "displayName": "string"
}
}
$_type | string Default: "AccountOrderBy" Value: "AccountOrderBy" |
field | string (EAccountOrderByField) Enum: "ID" "NAME" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["ID: Sort by the 'id' attribute","NAME: Sort by the 'name' attribute","CREATION_TIMESTAMP: Sort by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Sort by the 'modificationTimestamp' attribute"] |
order | string (Order) Enum: "ASCENDING" "DESCENDING" enum-descriptions: ["ASCENDING: Sort in the ascending order (smallest to largest, 0 to 9, and/or A to Z)","DESCENDING: Sort in the descending order (largest to smallest, 9 to 0, and/or Z to A)"] |
{- "$_type": "AccountOrderBy",
- "field": "ID",
- "order": "ASCENDING"
}
$_type | string Default: "AccountQuery" Value: "AccountQuery" |
Array of any (AccountSearchFilter) [ items ] List of filters to narrow the search of entities | |
Array of objects (AccountOrderBy) [ items ] List of criteria to order the search result list | |
offset | integer <int32> Offset position in the result set to start pagination |
limit | integer <int32> Maximal amount of items returned |
{- "$_type": "AccountQuery",
- "searchFilters": [
- {
- "$_type": "CreationTimestampAccountSearchFilter",
- "field": "NAME",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
], - "orderBy": [
- {
- "$_type": "AccountOrderBy",
- "field": "ID",
- "order": "ASCENDING"
}
], - "offset": 0,
- "limit": 0
}
$_type | string Default: "AccountResult" Value: "AccountResult" |
hasMoreItems | boolean Flag to indicate if there are more items on the server |
nextOffset | integer <int32> If more items are present on the server, this value can be used as offset in the next query |
Array of objects (Account) [ items ] The returned list of entities |
{- "$_type": "AccountResult",
- "hasMoreItems": true,
- "nextOffset": 0,
- "items": [
- {
- "$_type": "Account",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "name": "string",
- "billingAddress": "string",
- "contactAddress": "string",
- "avatar": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}
}
]
}
$_type | string Default: "CreationTimestampAccountSearchFilter" Value: "CreationTimestampAccountSearchFilter" |
field | string (EAccountSearchFilterField) enum-descriptions: ["NAME: Filter by the 'name' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] CREATION_TIMESTAMP NAME CREATION_TIMESTAMP MODIFICATION_TIMESTAMP |
any (TimestampOperator) |
{- "$_type": "CreationTimestampAccountSearchFilter",
- "field": "CREATION_TIMESTAMP",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
$_type | string Default: "AccountSecret" Value: "AccountSecret" |
id | string Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway. |
creationTimestamp | integer <int64> Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
modificationTimestamp | integer <int64> Timestamp of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
version | integer <int64> Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted. |
accountId | string Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
secretKey | string |
{- "$_type": "AccountSecret",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "secretKey": "string"
}
$_type | string Default: "AccountUserContainer" Value: "AccountUserContainer" |
object (Account) Model of an account. The contact and the billing address can be directly resolved when using the expand feature. | |
object (User) Model of a user. A user is normally an agent and/or a person who manages the system |
{- "$_type": "AccountUserContainer",
- "account": {
- "$_type": "Account",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "name": "string",
- "billingAddress": "string",
- "contactAddress": "string",
- "avatar": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}
}, - "adminUser": {
- "$_type": "User",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "avatar": "string",
- "username": "string",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "authorizationRole": "SUPER_ADMIN",
- "displayName": "string",
- "firstName": "string",
- "lastName": "string",
- "externallyManaged": true,
- "virtualUser": true,
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
}
$_type | string Default: "Address" Value: "Address" |
id | string Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway. |
creationTimestamp | integer <int64> Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
modificationTimestamp | integer <int64> Timestamp of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
version | integer <int64> Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted. |
accountId | string Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
organisationName | string Name of the organisation. Maximum of 250 characters. Can be omitted. |
addressLine1 | string First address line. Maximum of 250 characters. Can be omitted. |
addressLine2 | string Second address line. Maximum of 250 characters. Can be omitted. |
zip | string Zip code of the city. Maximum of 20 characters. Can not be omitted. |
city | string City name. Maximum of 250 characters. Can not be omitted. |
state | string Country state. Maximum of 250 characters. Can be omitted. |
country | string Country. Maximum of 250 characters. Can not be omitted. |
{- "$_type": "Address",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "organisationName": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "zip": "string",
- "city": "string",
- "state": "string",
- "country": "string"
}
$_type | string Default: "AddressOrderBy" Value: "AddressOrderBy" |
field | string (EAddressOrderByField) Enum: "ID" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["ID: Sort by the 'id' attribute","CREATION_TIMESTAMP: Sort by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Sort by the 'modificationTimestamp' attribute"] |
order | string (Order) Enum: "ASCENDING" "DESCENDING" enum-descriptions: ["ASCENDING: Sort in the ascending order (smallest to largest, 0 to 9, and/or A to Z)","DESCENDING: Sort in the descending order (largest to smallest, 9 to 0, and/or Z to A)"] |
{- "$_type": "AddressOrderBy",
- "field": "ID",
- "order": "ASCENDING"
}
$_type | string Default: "AddressQuery" Value: "AddressQuery" |
Array of any (AddressSearchFilter) [ items ] List of filters to narrow the search of entities | |
Array of objects (AddressOrderBy) [ items ] List of criteria to order the search result list | |
offset | integer <int32> Offset position in the result set to start pagination |
limit | integer <int32> Maximal amount of items returned |
{- "$_type": "AddressQuery",
- "searchFilters": [
- {
- "$_type": "CreationTimestampAddressSearchFilter",
- "field": "CREATION_TIMESTAMP",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
], - "orderBy": [
- {
- "$_type": "AddressOrderBy",
- "field": "ID",
- "order": "ASCENDING"
}
], - "offset": 0,
- "limit": 0
}
$_type | string Default: "AddressResult" Value: "AddressResult" |
hasMoreItems | boolean Flag to indicate if there are more items on the server |
nextOffset | integer <int32> If more items are present on the server, this value can be used as offset in the next query |
Array of objects (Address) [ items ] The returned list of entities |
{- "$_type": "AddressResult",
- "hasMoreItems": true,
- "nextOffset": 0,
- "items": [
- {
- "$_type": "Address",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "organisationName": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "zip": "string",
- "city": "string",
- "state": "string",
- "country": "string"
}
]
}
$_type | string Default: "CreationTimestampAddressSearchFilter" Value: "CreationTimestampAddressSearchFilter" |
field | string (EAddressSearchFilterField) enum-descriptions: ["CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] CREATION_TIMESTAMP CREATION_TIMESTAMP MODIFICATION_TIMESTAMP |
any (TimestampOperator) |
{- "$_type": "CreationTimestampAddressSearchFilter",
- "field": "CREATION_TIMESTAMP",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
$_type | string Default: "AgentForwardingCreatedEvent" Value: "AgentForwardingCreatedEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
invitationId | string Id of the invitation |
conversationId | string Id of the conversation |
token | string Token (digits for pin or character sequence) requested to redeem or revoke the invitation |
dateCreated | integer <int64> Unix timestamp when the event was created |
creatorType | string (EInvitationCreatorType) Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR" enum-descriptions: ["WEB_API: Invitation created with the API","SYSTEM: Invitation created by the system","AGENT: Invitation created by an agent","VISITOR: Invitation created by a visitor"] The type of the person/system who created an invitation |
object (PersonData) Representation of a Person (Agent or Visitor). | |
object (ContextPersonInfo) Information about the context person of a conversation. Normally send together with webhook events. | |
any (AgentTargetData) Target of an 'agent forwarding' or an 'agent invitation' event which can be the agent directly (as | |
comment | string Text provided by the creator for the target |
Array of objects (ConversationLink) [ items ] List of links that can be used to accept the accept forwarding event with the token. |
{- "$_type": "AgentForwardingCreatedEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "invitationId": "string",
- "conversationId": "string",
- "token": "string",
- "dateCreated": 0,
- "creatorType": "WEB_API",
- "creatorPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "contextPersonInfo": {
- "$_type": "ContextPersonInfo",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "osName": "string",
- "osVersion": "string",
- "browserName": "string",
- "browserVersion": "string",
- "locale": "string",
- "city": "string",
- "country": "string"
}, - "target": {
- "$_type": "TeamData",
- "id": "string",
- "accountId": "string",
- "displayName": "string",
- "avatar": "string",
- "parentId": "string"
}, - "comment": "string",
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
]
}
$_type | string Default: "AgentForwardingRedeemedEvent" Value: "AgentForwardingRedeemedEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
invitationId | string Id of the invitation |
conversationId | string Id of the conversation |
token | string Token (digits for pin or character sequence) requested to redeem or revoke the invitation |
dateCreated | integer <int64> Unix timestamp when the event was created |
creatorType | string (EInvitationCreatorType) Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR" enum-descriptions: ["WEB_API: Invitation created with the API","SYSTEM: Invitation created by the system","AGENT: Invitation created by an agent","VISITOR: Invitation created by a visitor"] The type of the person/system who created an invitation |
object (PersonData) Representation of a Person (Agent or Visitor). | |
object (ContextPersonInfo) Information about the context person of a conversation. Normally send together with webhook events. | |
any (AgentTargetData) Target of an 'agent forwarding' or an 'agent invitation' event which can be the agent directly (as | |
comment | string Text provided by the creator for the target |
object (PersonData) Representation of a Person (Agent or Visitor). |
{- "$_type": "AgentForwardingRedeemedEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "invitationId": "string",
- "conversationId": "string",
- "token": "string",
- "dateCreated": 0,
- "creatorType": "WEB_API",
- "creatorPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "contextPersonInfo": {
- "$_type": "ContextPersonInfo",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "osName": "string",
- "osVersion": "string",
- "browserName": "string",
- "browserVersion": "string",
- "locale": "string",
- "city": "string",
- "country": "string"
}, - "target": {
- "$_type": "TeamData",
- "id": "string",
- "accountId": "string",
- "displayName": "string",
- "avatar": "string",
- "parentId": "string"
}, - "comment": "string",
- "redeemingPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}
}
$_type | string Default: "AgentForwardingRevokedEvent" Value: "AgentForwardingRevokedEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
invitationId | string Id of the invitation |
conversationId | string Id of the conversation |
token | string Token (digits for pin or character sequence) requested to redeem or revoke the invitation |
dateCreated | integer <int64> Unix timestamp when the event was created |
creatorType | string (EInvitationCreatorType) Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR" enum-descriptions: ["WEB_API: Invitation created with the API","SYSTEM: Invitation created by the system","AGENT: Invitation created by an agent","VISITOR: Invitation created by a visitor"] The type of the person/system who created an invitation |
object (PersonData) Representation of a Person (Agent or Visitor). | |
object (ContextPersonInfo) Information about the context person of a conversation. Normally send together with webhook events. | |
any (AgentTargetData) Target of an 'agent forwarding' or an 'agent invitation' event which can be the agent directly (as | |
comment | string Text provided by the creator for the target |
{- "$_type": "AgentForwardingRevokedEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "invitationId": "string",
- "conversationId": "string",
- "token": "string",
- "dateCreated": 0,
- "creatorType": "WEB_API",
- "creatorPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "contextPersonInfo": {
- "$_type": "ContextPersonInfo",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "osName": "string",
- "osVersion": "string",
- "browserName": "string",
- "browserVersion": "string",
- "locale": "string",
- "city": "string",
- "country": "string"
}, - "target": {
- "$_type": "TeamData",
- "id": "string",
- "accountId": "string",
- "displayName": "string",
- "avatar": "string",
- "parentId": "string"
}, - "comment": "string"
}
$_type | string Default: "AgentInvitationCreatedEvent" Value: "AgentInvitationCreatedEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
invitationId | string Id of the invitation |
conversationId | string Id of the conversation |
token | string Token (digits for pin or character sequence) requested to redeem or revoke the invitation |
dateCreated | integer <int64> Unix timestamp when the event was created |
creatorType | string (EInvitationCreatorType) Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR" enum-descriptions: ["WEB_API: Invitation created with the API","SYSTEM: Invitation created by the system","AGENT: Invitation created by an agent","VISITOR: Invitation created by a visitor"] The type of the person/system who created an invitation |
object (PersonData) Representation of a Person (Agent or Visitor). | |
object (ContextPersonInfo) Information about the context person of a conversation. Normally send together with webhook events. | |
any (AgentTargetData) Target of an 'agent forwarding' or an 'agent invitation' event which can be the agent directly (as | |
comment | string Text provided by the creator for the target |
Array of objects (ConversationLink) [ items ] List of links that can be used to accept the agent invitation event with the token. |
{- "$_type": "AgentInvitationCreatedEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "invitationId": "string",
- "conversationId": "string",
- "token": "string",
- "dateCreated": 0,
- "creatorType": "WEB_API",
- "creatorPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "contextPersonInfo": {
- "$_type": "ContextPersonInfo",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "osName": "string",
- "osVersion": "string",
- "browserName": "string",
- "browserVersion": "string",
- "locale": "string",
- "city": "string",
- "country": "string"
}, - "target": {
- "$_type": "TeamData",
- "id": "string",
- "accountId": "string",
- "displayName": "string",
- "avatar": "string",
- "parentId": "string"
}, - "comment": "string",
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
]
}
$_type | string Default: "AgentInvitationRedeemedEvent" Value: "AgentInvitationRedeemedEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
invitationId | string Id of the invitation |
conversationId | string Id of the conversation |
token | string Token (digits for pin or character sequence) requested to redeem or revoke the invitation |
dateCreated | integer <int64> Unix timestamp when the event was created |
creatorType | string (EInvitationCreatorType) Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR" enum-descriptions: ["WEB_API: Invitation created with the API","SYSTEM: Invitation created by the system","AGENT: Invitation created by an agent","VISITOR: Invitation created by a visitor"] The type of the person/system who created an invitation |
object (PersonData) Representation of a Person (Agent or Visitor). | |
object (ContextPersonInfo) Information about the context person of a conversation. Normally send together with webhook events. | |
any (AgentTargetData) Target of an 'agent forwarding' or an 'agent invitation' event which can be the agent directly (as | |
comment | string Text provided by the creator for the target |
object (PersonData) Representation of a Person (Agent or Visitor). |
{- "$_type": "AgentInvitationRedeemedEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "invitationId": "string",
- "conversationId": "string",
- "token": "string",
- "dateCreated": 0,
- "creatorType": "WEB_API",
- "creatorPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "contextPersonInfo": {
- "$_type": "ContextPersonInfo",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "osName": "string",
- "osVersion": "string",
- "browserName": "string",
- "browserVersion": "string",
- "locale": "string",
- "city": "string",
- "country": "string"
}, - "target": {
- "$_type": "TeamData",
- "id": "string",
- "accountId": "string",
- "displayName": "string",
- "avatar": "string",
- "parentId": "string"
}, - "comment": "string",
- "redeemingPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}
}
$_type | string Default: "AgentInvitationRevokedEvent" Value: "AgentInvitationRevokedEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
invitationId | string Id of the invitation |
conversationId | string Id of the conversation |
token | string Token (digits for pin or character sequence) requested to redeem or revoke the invitation |
dateCreated | integer <int64> Unix timestamp when the event was created |
creatorType | string (EInvitationCreatorType) Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR" enum-descriptions: ["WEB_API: Invitation created with the API","SYSTEM: Invitation created by the system","AGENT: Invitation created by an agent","VISITOR: Invitation created by a visitor"] The type of the person/system who created an invitation |
object (PersonData) Representation of a Person (Agent or Visitor). | |
object (ContextPersonInfo) Information about the context person of a conversation. Normally send together with webhook events. | |
any (AgentTargetData) Target of an 'agent forwarding' or an 'agent invitation' event which can be the agent directly (as | |
comment | string Text provided by the creator for the target |
{- "$_type": "AgentInvitationRevokedEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "invitationId": "string",
- "conversationId": "string",
- "token": "string",
- "dateCreated": 0,
- "creatorType": "WEB_API",
- "creatorPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "contextPersonInfo": {
- "$_type": "ContextPersonInfo",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "osName": "string",
- "osVersion": "string",
- "browserName": "string",
- "browserVersion": "string",
- "locale": "string",
- "city": "string",
- "country": "string"
}, - "target": {
- "$_type": "TeamData",
- "id": "string",
- "accountId": "string",
- "displayName": "string",
- "avatar": "string",
- "parentId": "string"
}, - "comment": "string"
}
$_type | string Default: "PersonData" PersonData TeamData PersonData |
id | string Unique id of the person, when creating a person this property can be omitted as it will be generated by the server anyway. |
accountId | string Account id to which a Person belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
personSource | string (EPersonSource) Enum: "USER_DB" "VIRTUAL" enum-descriptions: ["USER_DB: Person-Source is on the main_user table","VIRTUAL: Person-Source is only virtual (no seperate storage)"] The source type of a person (participant of a conversation) |
sourceId | string Identifier of the person in its source (defined by |
sourceData | string Vendor specific data. |
firstName | string The first name of the person. Maximum length of 250 characters. Can be omitted. |
lastName | string the last name of the person. Maximum length of 250 characters. Can be omitted. |
username | string The username of the person. When firstName and lastName are unknown, it is recommended to use this value to change the displayName. Depending on the configuration, this is may also be the email of the corresponding user. Maximum length of 250 characters. Can be omitted. |
nickname | string A name that an anonymous person has given itself. Maximum length of 250 characters. Can be omitted. |
displayName | string Display name of the person. This is read only information, it will be set by the server anyway. |
personType | string (EPersonType) Enum: "AGENT" "VISITOR" "SYSTEM" "BOT" enum-descriptions: ["AGENT: Agent participant","VISITOR: Visitor participant","SYSTEM: System participant","BOT: Bot participant"] The type of a person (participant of a session) |
authorizationRole | string (EAuthorizationRole) Enum: "SUPER_ADMIN" "PARTNER" "TECHNICAL_ADMIN" "ADMIN" "SUPERVISOR" "REGISTERED_USER" "WEBUSER" "ANONYMOUS_USER" enum-descriptions: ["SUPER_ADMIN: Super admin role. Only for unblu or system admins","PARTNER: Partner role. (no longer used)","TECHNICAL_ADMIN: Technical admin role.","ADMIN: Admin role. For Admins of the system","SUPERVISOR: Supervisor role. For users which manage teams","REGISTERED_USER: User role. For normal users (agents)","WEBUSER: Webuser role. For internal representation of users from the outside","ANONYMOUS_USER: Anonymous role. For internal representation of unknown users"] The authorization role is mainly used for access definition of a service |
string The email of the person. Optional. | |
phone | string The phone of the person. Optional. |
teamId | string Team id of the person. Optional. |
teamName | string Team name of the person, only present when the team id is set. When creating or updating a person this property can be omitted as it will be set by the server anyway. |
string or Avatar (object) expand-query-key: avatar type: ExpandableField Avatar of the entity: id that can be expanded. | |
object expand-query-key: metadata type: Map The entity's metadata properties. Only contains values when the 'expand' query parameter is used with the value 'metadata'. |
{- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}
$_type | string Default: "AllEqualIdListOperator" Value: "AllEqualIdListOperator" |
type | string (EIdListOperatorType) Enum: "ALL_OF" "ANY_OF" "ALL_EQUAL" enum-descriptions: ["ALL_OF: Checks if all of the values are present in the value list provided by the operator.","ANY_OF: Checks if any of the values is equal to any of the values in the list provided by the operator.","ALL_EQUAL: Check if the lists are of the same length and contain same values."] Operator types corresponding to operators defined by |
values | Array of strings |
{- "$_type": "AllEqualIdListOperator",
- "type": "ALL_OF",
- "values": [
- "string"
]
}
$_type | string Default: "AllOfIdListOperator" Value: "AllOfIdListOperator" |
type | string (EIdListOperatorType) Enum: "ALL_OF" "ANY_OF" "ALL_EQUAL" enum-descriptions: ["ALL_OF: Checks if all of the values are present in the value list provided by the operator.","ANY_OF: Checks if any of the values is equal to any of the values in the list provided by the operator.","ALL_EQUAL: Check if the lists are of the same length and contain same values."] Operator types corresponding to operators defined by |
values | Array of strings |
{- "$_type": "AllOfIdListOperator",
- "type": "ALL_OF",
- "values": [
- "string"
]
}
$_type | string Default: "AnyOfIdListOperator" Value: "AnyOfIdListOperator" |
type | string (EIdListOperatorType) Enum: "ALL_OF" "ANY_OF" "ALL_EQUAL" enum-descriptions: ["ALL_OF: Checks if all of the values are present in the value list provided by the operator.","ANY_OF: Checks if any of the values is equal to any of the values in the list provided by the operator.","ALL_EQUAL: Check if the lists are of the same length and contain same values."] Operator types corresponding to operators defined by |
values | Array of strings |
{- "$_type": "AnyOfIdListOperator",
- "type": "ALL_OF",
- "values": [
- "string"
]
}
$_type | string Default: "ApiKey" Value: "ApiKey" |
id | string Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway. |
creationTimestamp | integer <int64> Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
modificationTimestamp | integer <int64> Timestamp of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
version | integer <int64> Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted. |
accountId | string Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
apiKey | string Api key string. When creating the entity it can be set to a specific value or omitted (in the second case a random value will be generated by the server). Can not be updated. |
name | string Name of the api key. Maximum of 250 characters. Can be omitted, but should not. |
description | string Description of the api key. E.g. where or for what it is used. Maximum of 500 characters. Can be omitted. |
object expand-query-key: configuration type: Map The entity's configuration properties. Only contains values when the 'expand' query parameter is used with the value 'configuration'. | |
object expand-query-key: text type: Map The entity's text properties. Only contains values when the 'expand' query parameter is used with the value 'text'. | |
object expand-query-key: metadata type: Map The entity's metadata properties. Only contains values when the 'expand' query parameter is used with the value 'metadata'. |
{- "$_type": "ApiKey",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "apiKey": "string",
- "name": "string",
- "description": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
$_type | string Default: "ApiKeyApiKeySearchFilter" Value: "ApiKeyApiKeySearchFilter" |
field | string (EApiKeySearchFilterField) Enum: "NAME" "DESCRIPTION" "API_KEY" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["NAME: Filter by the 'name' attribute","DESCRIPTION: Filter by the 'description' attribute","API_KEY: Filter by the 'apiKey' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] |
any (StringOperator) |
{- "$_type": "ApiKeyApiKeySearchFilter",
- "field": "NAME",
- "operator": {
- "$_type": "EqualsStringOperator",
- "type": "EQUALS",
- "value": "string"
}
}
$_type | string Default: "ApiKeyModificationEvent" Value: "ApiKeyModificationEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
action | string (EntityModificationAction) Enum: "CREATE" "UPDATE" "DELETE" enum-descriptions: ["CREATE: Entity was created","UPDATE: Entity was updated","DELETE: Entity was deleted"] Type of modification of an entity |
object (ApiKey) Model of an ApiKey. Api keys identify the usage of unblu to a certain account. There can be multiple api keys per account to define different configurations | |
object (UserInfo) User information which are normally used together with webhook events. |
{- "$_type": "ApiKeyModificationEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "action": "CREATE",
- "entity": {
- "$_type": "ApiKey",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "apiKey": "string",
- "name": "string",
- "description": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "editingUser": {
- "$_type": "UserInfo",
- "userId": "string",
- "userName": "string",
- "firstName": "string",
- "lastName": "string",
- "displayName": "string"
}
}
$_type | string Default: "ApiKeyOrderBy" Value: "ApiKeyOrderBy" |
field | string (EApiKeyOrderByField) Enum: "ID" "NAME" "DESCRIPTION" "API_KEY" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["ID: Sort by the 'id' attribute","NAME: Sort by the 'name' attribute","DESCRIPTION: Sort by the 'description' attribute","API_KEY: Sort by the 'apiKey' attribute","CREATION_TIMESTAMP: Sort by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Sort by the 'modificationTimestamp' attribute"] |
order | string (Order) Enum: "ASCENDING" "DESCENDING" enum-descriptions: ["ASCENDING: Sort in the ascending order (smallest to largest, 0 to 9, and/or A to Z)","DESCENDING: Sort in the descending order (largest to smallest, 9 to 0, and/or Z to A)"] |
{- "$_type": "ApiKeyOrderBy",
- "field": "ID",
- "order": "ASCENDING"
}
$_type | string Default: "ApiKeyQuery" Value: "ApiKeyQuery" |
Array of any (ApiKeySearchFilter) [ items ] List of filters to narrow the search of entities | |
Array of objects (ApiKeyOrderBy) [ items ] List of criteria to order the search result list | |
offset | integer <int32> Offset position in the result set to start pagination |
limit | integer <int32> Maximal amount of items returned |
{- "$_type": "ApiKeyQuery",
- "searchFilters": [
- {
- "$_type": "ApiKeyApiKeySearchFilter",
- "field": "NAME",
- "operator": {
- "$_type": "EqualsStringOperator",
- "type": "EQUALS",
- "value": "string"
}
}
], - "orderBy": [
- {
- "$_type": "ApiKeyOrderBy",
- "field": "ID",
- "order": "ASCENDING"
}
], - "offset": 0,
- "limit": 0
}
$_type | string Default: "ApiKeyResult" Value: "ApiKeyResult" |
hasMoreItems | boolean Flag to indicate if there are more items on the server |
nextOffset | integer <int32> If more items are present on the server, this value can be used as offset in the next query |
Array of objects (ApiKey) [ items ] The returned list of entities |
{- "$_type": "ApiKeyResult",
- "hasMoreItems": true,
- "nextOffset": 0,
- "items": [
- {
- "$_type": "ApiKey",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "apiKey": "string",
- "name": "string",
- "description": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
]
}
$_type | string Default: "ApiKeyApiKeySearchFilter" Value: "ApiKeyApiKeySearchFilter" |
field | string (EApiKeySearchFilterField) enum-descriptions: ["NAME: Filter by the 'name' attribute","DESCRIPTION: Filter by the 'description' attribute","API_KEY: Filter by the 'apiKey' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] API_KEY NAME DESCRIPTION API_KEY CREATION_TIMESTAMP MODIFICATION_TIMESTAMP |
any (StringOperator) |
{- "$_type": "ApiKeyApiKeySearchFilter",
- "field": "API_KEY",
- "operator": {
- "$_type": "EqualsStringOperator",
- "type": "EQUALS",
- "value": "string"
}
}
$_type | string Default: "ApprovalRequestMessageData" Value: "ApprovalRequestMessageData" |
id | string The ID of the message. |
conversationId | string Conversation ID to which this message belongs to |
externalMessengerChannelId | string ID of the external messenger channel connected to the conversation. Null if the conversation is not connected to an external messenger. |
accountId | string Account ID to which this message and conversation belongs to. |
object (PersonData) Representation of a Person (Agent or Visitor). | |
senderPersonPresenceId | string Id of the person presence that sends the message. May be null if the message was sent by the system. |
serverTimestamp | integer <int64> utc timestamp when the message was received on the server. |
sendTimestamp | integer <int64> utc timestamp when the message was sent from the client |
type | string (EMessageType) Enum: "TEXT" "FILE" "CARD" "LIST" "APPROVAL_REQUEST" "MULTICHOICE_QUESTION" "RATING_QUESTION" "TEXT_QUESTION" "REPLY" "QUESTION_ABORTED" enum-descriptions: ["TEXT","FILE","CARD","LIST","APPROVAL_REQUEST","MULTICHOICE_QUESTION","RATING_QUESTION","TEXT_QUESTION","REPLY","QUESTION_ABORTED"] The message type of a conversation message |
recipientPersonIds | Array of strings Person IDs of the recipients of the message. If it is null, all active participations are recipients |
fallbackText | string Text representation of the message which is used in following cases:
The fallback text can be provided by the sender (bot, external messenger) or is generated when missing. This may however not always be a perfect textual representation of the message. |
actionId | string An ID of the action triggering the message to be able to identify a message created by an action. |
sourceId | string A custom ID which identifies where this message initially came from. |
text | string Text of the message |
textType | string (EConversationMessageTextType) Enum: "SIMPLE_TEXT" "MARKDOWN" enum-descriptions: ["SIMPLE_TEXT: Text will be interpreted as simple text. <p> Auto link detection will still be possible.","MARKDOWN: Text will be interpreted as Markdown. <p> The supported Markdown subset depends on the message type."] How text in a conversation message should be interpreted. |
Array of objects (MultichoiceQuestionOption) [ items ] Response options for the question. | |
answerStatus | string (EAnswerStatus) Enum: "PENDING" "ANSWERED" "TIMEDOUT" "CANCELED" enum-descriptions: ["PENDING: Question is not answered yet","ANSWERED: Question was successfully answered","TIMEDOUT: Question was running into a timeout","CANCELED: Question was canceled by the system, a bot or an external messenger channel"] The state of a question message |
{- "$_type": "ApprovalRequestMessageData",
- "id": "string",
- "conversationId": "string",
- "externalMessengerChannelId": "string",
- "accountId": "string",
- "senderPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "senderPersonPresenceId": "string",
- "serverTimestamp": 0,
- "sendTimestamp": 0,
- "type": "TEXT",
- "recipientPersonIds": [
- "string"
], - "fallbackText": "string",
- "actionId": "string",
- "sourceId": "string",
- "text": "string",
- "textType": "SIMPLE_TEXT",
- "options": [
- {
- "$_type": "MultichoiceQuestionOption",
- "label": "string",
- "value": "string",
- "primary": true
}
], - "answerStatus": "PENDING"
}
$_type | string Default: "ArrayBody" Value: "ArrayBody" |
Array of objects (BodyElement) [ items ] |
{- "$_type": "ArrayBody",
- "elements": [
- {
- "$_type": "BodyElement",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- {
- "$_type": "ServiceTypeBinding",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- { }
]
}
], - "name": "string",
- "documentation": "string"
}
]
}
$_type | string Default: "AssigneePersonIdConversationSearchFilter" Value: "AssigneePersonIdConversationSearchFilter" |
field | string (EConversationSearchFilterField) Enum: "CREATION_TIMESTAMP" "END_TIMESTAMP" "INITIAL_ENGAGEMENT_TYPE" "TOPIC" "CONTEXT_PERSON_ID" "ASSIGNEE_PERSON_ID" "PARTICIPANT_PERSON_ID" "STATE" "END_REASON" "CONVERSATION_TEMPLATE_ID" "RECIPIENT_ID" "RECIPIENT_TYPE" "TOKBOX_SESSION_ID" enum-descriptions: ["CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","END_TIMESTAMP: Filter by the 'endTimestamp' attribute","INITIAL_ENGAGEMENT_TYPE: Filter by the 'initialEngagementType' attribute","TOPIC: Filter by the 'topic' attribute","CONTEXT_PERSON_ID: Filter by the 'contextPersonId' attribute","ASSIGNEE_PERSON_ID: Filter by the 'assigneePersonId' attribute","PARTICIPANT_PERSON_ID: Filter by the 'personId' of the participants","STATE: Filter by the 'state' attribute","END_REASON: Filter by the 'endReason' attribute","CONVERSATION_TEMPLATE_ID: Filter by the 'conversationTemplateId' attribute","RECIPIENT_ID: Filter by the 'id' of the 'recipient' attribute","RECIPIENT_TYPE: Filter by the 'type' of the 'recipient' attribute","TOKBOX_SESSION_ID: Filter by the 'tokboxSessionId' attribute"] |
any (IdOperator) Defines operators used for comparing id fields in tables. |
{- "$_type": "AssigneePersonIdConversationSearchFilter",
- "field": "CREATION_TIMESTAMP",
- "operator": {
- "$_type": "EqualsIdOperator",
- "type": "EQUALS",
- "value": "string"
}
}
$_type | string Default: "AssignmentRequestCreatedEvent" Value: "AssignmentRequestCreatedEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
invitationId | string Id of the invitation |
conversationId | string Id of the conversation |
token | string Token (digits for pin or character sequence) requested to redeem or revoke the invitation |
dateCreated | integer <int64> Unix timestamp when the event was created |
creatorType | string (EInvitationCreatorType) Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR" enum-descriptions: ["WEB_API: Invitation created with the API","SYSTEM: Invitation created by the system","AGENT: Invitation created by an agent","VISITOR: Invitation created by a visitor"] The type of the person/system who created an invitation |
object (PersonData) Representation of a Person (Agent or Visitor). | |
object (ContextPersonInfo) Information about the context person of a conversation. Normally send together with webhook events. | |
any (ConversationRecipientData) Recipient of a conversation: Either a single | |
Array of objects (ConversationLink) [ items ] List of links that can be used to accept the assignment request event with the token. | |
initialEngagementUrl | string The URL where the visitor originating the conversation was. Only available for conversations originated by a visitor where Unblu was integrated in the customers website. e.g. conversations initiated from the mobile SDK won't have an initial engagement URL. |
{- "$_type": "AssignmentRequestCreatedEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "invitationId": "string",
- "conversationId": "string",
- "token": "string",
- "dateCreated": 0,
- "creatorType": "WEB_API",
- "creatorPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "contextPersonInfo": {
- "$_type": "ContextPersonInfo",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "osName": "string",
- "osVersion": "string",
- "browserName": "string",
- "browserVersion": "string",
- "locale": "string",
- "city": "string",
- "country": "string"
}, - "target": {
- "$_type": "AccountData",
- "id": "string",
- "displayName": "string",
- "avatar": "string"
}, - "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
], - "initialEngagementUrl": "string"
}
$_type | string Default: "AssignmentRequestRedeemedEvent" Value: "AssignmentRequestRedeemedEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
invitationId | string Id of the invitation |
conversationId | string Id of the conversation |
token | string Token (digits for pin or character sequence) requested to redeem or revoke the invitation |
dateCreated | integer <int64> Unix timestamp when the event was created |
creatorType | string (EInvitationCreatorType) Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR" enum-descriptions: ["WEB_API: Invitation created with the API","SYSTEM: Invitation created by the system","AGENT: Invitation created by an agent","VISITOR: Invitation created by a visitor"] The type of the person/system who created an invitation |
object (PersonData) Representation of a Person (Agent or Visitor). | |
object (ContextPersonInfo) Information about the context person of a conversation. Normally send together with webhook events. | |
any (ConversationRecipientData) Recipient of a conversation: Either a single | |
object (PersonData) Representation of a Person (Agent or Visitor). |
{- "$_type": "AssignmentRequestRedeemedEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "invitationId": "string",
- "conversationId": "string",
- "token": "string",
- "dateCreated": 0,
- "creatorType": "WEB_API",
- "creatorPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "contextPersonInfo": {
- "$_type": "ContextPersonInfo",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "osName": "string",
- "osVersion": "string",
- "browserName": "string",
- "browserVersion": "string",
- "locale": "string",
- "city": "string",
- "country": "string"
}, - "target": {
- "$_type": "AccountData",
- "id": "string",
- "displayName": "string",
- "avatar": "string"
}, - "redeemingPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}
}
$_type | string Default: "AssignmentRequestRevokedEvent" Value: "AssignmentRequestRevokedEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
invitationId | string Id of the invitation |
conversationId | string Id of the conversation |
token | string Token (digits for pin or character sequence) requested to redeem or revoke the invitation |
dateCreated | integer <int64> Unix timestamp when the event was created |
creatorType | string (EInvitationCreatorType) Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR" enum-descriptions: ["WEB_API: Invitation created with the API","SYSTEM: Invitation created by the system","AGENT: Invitation created by an agent","VISITOR: Invitation created by a visitor"] The type of the person/system who created an invitation |
object (PersonData) Representation of a Person (Agent or Visitor). | |
object (ContextPersonInfo) Information about the context person of a conversation. Normally send together with webhook events. | |
any (ConversationRecipientData) Recipient of a conversation: Either a single |
{- "$_type": "AssignmentRequestRevokedEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "invitationId": "string",
- "conversationId": "string",
- "token": "string",
- "dateCreated": 0,
- "creatorType": "WEB_API",
- "creatorPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "contextPersonInfo": {
- "$_type": "ContextPersonInfo",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "osName": "string",
- "osVersion": "string",
- "browserName": "string",
- "browserVersion": "string",
- "locale": "string",
- "city": "string",
- "country": "string"
}, - "target": {
- "$_type": "AccountData",
- "id": "string",
- "displayName": "string",
- "avatar": "string"
}
}
oldPassword | string The old password for validation |
newPassword | string The new password to set |
{- "oldPassword": "string",
- "newPassword": "string"
}
password | string Password to check against policy |
{- "password": "string"
}
username | string The username for which the token is created |
password | string The password of the user to authenticate |
{- "username": "string",
- "password": "string"
}
username | string If set and userid is set to null, the user is searched by the name |
userId | string If set, the username is ignored and the user for the given id is impersonated |
superUser | boolean if true, the impersonated user will have the SUPER_ADMIN role (even if he hasn't normally). |
redirectOnSuccess | string redirection URL when the operation is successful |
redirectOnFailure | string redirection URL when the operation is not successful |
{- "username": "string",
- "userId": "string",
- "superUser": true,
- "redirectOnSuccess": "string",
- "redirectOnFailure": "string"
}
username | string user to use for login |
password | string password to use for login |
redirectOnSuccess | string redirection URL when the operation is successful |
redirectOnFailure | string redirection URL when the operation is not successful |
{- "username": "string",
- "password": "string",
- "redirectOnSuccess": "string",
- "redirectOnFailure": "string"
}
redirectOnSuccess | string redirection URL when the operation is successful |
{- "redirectOnSuccess": "string"
}
redirectOnSuccess | string redirection URL when the operation is successful. Also if nothing needed to be done. |
redirectOnFailure | string redirection URL when the operation is not successful |
{- "redirectOnSuccess": "string",
- "redirectOnFailure": "string"
}
username | string The username of the user which receives a password reset mail |
{- "username": "string"
}
locale | string The new locale in the language-tag format (as defined in the IETF BCP 47) which should be used (e.g. en - english, de - german, fr - french, it - italian) |
{- "locale": "string"
}
authenticationToken | string for authentication. |
password | string the new password to be used |
{- "authenticationToken": "string",
- "password": "string"
}
accountId | string the account id to impersonate on |
redirectOnSuccess | string redirection URL when the operation is successful |
redirectOnFailure | string redirection URL when the operation is not successful |
{- "accountId": "string",
- "redirectOnSuccess": "string",
- "redirectOnFailure": "string"
}
$_type | string Default: "EqualsAuthorizationRoleOperator" Value: "EqualsAuthorizationRoleOperator" |
type | string (EAuthorizationRoleOperatorType) enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator"] EQUALS EQUALS NOT_EQUALS IN NOT_IN |
value | string (EAuthorizationRole) Enum: "SUPER_ADMIN" "PARTNER" "TECHNICAL_ADMIN" "ADMIN" "SUPERVISOR" "REGISTERED_USER" "WEBUSER" "ANONYMOUS_USER" enum-descriptions: ["SUPER_ADMIN: Super admin role. Only for unblu or system admins","PARTNER: Partner role. (no longer used)","TECHNICAL_ADMIN: Technical admin role.","ADMIN: Admin role. For Admins of the system","SUPERVISOR: Supervisor role. For users which manage teams","REGISTERED_USER: User role. For normal users (agents)","WEBUSER: Webuser role. For internal representation of users from the outside","ANONYMOUS_USER: Anonymous role. For internal representation of unknown users"] The authorization role is mainly used for access definition of a service |
{- "$_type": "EqualsAuthorizationRoleOperator",
- "type": "EQUALS",
- "value": "SUPER_ADMIN"
}
$_type | string Default: "AuthorizationRolePersonSearchFilter" Value: "AuthorizationRolePersonSearchFilter" |
field | string (EPersonSearchFilterField) Enum: "PERSON_SOURCE" "SOURCE_ID" "SOURCE_DATA" "FIRST_NAME" "LAST_NAME" "USERNAME" "NICKNAME" "PERSON_TYPE" "AUTHORIZATION_ROLE" "EMAIL" "PHONE" "TEAM_ID" enum-descriptions: ["PERSON_SOURCE: Filter by the 'personSource' attribute","SOURCE_ID: Filter by the 'sourceId' attribute","SOURCE_DATA: Filter by the 'sourceData' attribute","FIRST_NAME: Filter by the 'firstName' attribute","LAST_NAME: Filter by the 'lastName' attribute","USERNAME: Filter by the 'username' attribute","NICKNAME: Filter by the 'nickname' attribute","PERSON_TYPE: Filter by the 'personType' attribute","AUTHORIZATION_ROLE: Filter by the 'authorizationRole' attribute","EMAIL: Filter by the 'email' attribute","PHONE: Filter by the 'phone' attribute","TEAM_ID: Filter by the 'teamId' attribute"] |
any (AuthorizationRoleOperator) |
{- "$_type": "AuthorizationRolePersonSearchFilter",
- "field": "PERSON_SOURCE",
- "operator": {
- "$_type": "EqualsAuthorizationRoleOperator",
- "type": "EQUALS",
- "value": "SUPER_ADMIN"
}
}
$_type | string Default: "AuthorizationRoleUserSearchFilter" Value: "AuthorizationRoleUserSearchFilter" |
field | string (EUserSearchFilterField) Enum: "FIRST_NAME" "LAST_NAME" "USERNAME" "TEAM_ID" "EMAIL" "AUTHORIZATION_ROLE" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" "VIRTUAL_USER" enum-descriptions: ["FIRST_NAME: Filter by the 'firstName' attribute","LAST_NAME: Filter by the 'lastName' attribute","USERNAME: Filter by the 'username' attribute","TEAM_ID: Filter by the 'teamId' attribute","EMAIL: Filter by the 'email' attribute","AUTHORIZATION_ROLE: Filter by the 'authorizationRole' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute","VIRTUAL_USER: Filter by the 'virtualUser' attribute"] |
any (AuthorizationRoleOperator) |
{- "$_type": "AuthorizationRoleUserSearchFilter",
- "field": "FIRST_NAME",
- "operator": {
- "$_type": "EqualsAuthorizationRoleOperator",
- "type": "EQUALS",
- "value": "SUPER_ADMIN"
}
}
$_type | string Default: "Avatar" Value: "Avatar" |
id | string Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway. |
creationTimestamp | integer <int64> Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
modificationTimestamp | integer <int64> Timestamp of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
accountId | string Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
imageZoomFactor | number <float> Zoom factor to crop the original image. Must be bigger than 1. If omitted a minimal factor will be computed. |
imageXPositionRatio | number <float> Ratio to determine the horizontal position of the cropping area. Must be between 0 and 1: 0 means moved at the left border, 1 means moved at the right border. If omitted 0.5 will be used. |
imageYPositionRatio | number <float> Ratio to determine the vertical position of the cropping area. Must be between 0 and 1: 0 means moved at the top border, 1 means moved at the bottom border. If omitted 0.5 will be used. |
imageRotationAngle | integer <int32> Clockwise angle in degree (0-380) for rotation. If omitted 0 will be used. |
imageData | string Image content as data URL scheme (RFC2397 - |
{- "$_type": "Avatar",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "accountId": "string",
- "imageZoomFactor": 0,
- "imageXPositionRatio": 0,
- "imageYPositionRatio": 0,
- "imageRotationAngle": 0,
- "imageData": "string"
}
$_type | string Default: "BodyElement" Value: "BodyElement" |
typeName | string Name of the type |
isArray | boolean True if the type is an array |
numArrayDim | integer <int32> 0 if type is not an array. Otherwise the property defines the number of dimension of the property. E.g. with 2 a string type would be a 2 dim string array: string[][] |
isEnum | boolean True if the type is an enum |
Array of objects (ServiceTypeBinding) [ items ] Type arguments for generic types. E.g. a list has generic types: list<string> generic type would be string | |
name | string |
documentation | string |
{- "$_type": "BodyElement",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- {
- "$_type": "ServiceTypeBinding",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- { }
]
}
], - "name": "string",
- "documentation": "string"
}
$_type | string Default: "EqualsBooleanOperator" Value: "EqualsBooleanOperator" |
type | string (EBooleanOperatorType) enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IS_NULL: Check if the value is null","IS_NOT_NULL: Check if the value is not null"] EQUALS EQUALS NOT_EQUALS IS_NULL IS_NOT_NULL |
value | boolean |
{- "$_type": "EqualsBooleanOperator",
- "type": "EQUALS",
- "value": true
}
$_type | string Default: "BotDialogClosedEvent" Value: "BotDialogClosedEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
dialogToken | string Token for this dialog. It is present in every dialog webhook and must be passed to all Bot Web-API service calls to identify the dialog. |
{- "$_type": "BotDialogClosedEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "dialogToken": "string"
}
$_type | string Default: "BotDialogCounterpartChanged" Value: "BotDialogCounterpartChanged" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
dialogToken | string Token for this dialog. It is present in every dialog webhook and must be passed to all Bot Web-API service calls to identify the dialog. |
object (PersonData) Representation of a Person (Agent or Visitor). | |
object (PersonData) Representation of a Person (Agent or Visitor). |
{- "$_type": "BotDialogCounterpartChanged",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "dialogToken": "string",
- "oldCounterpartPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "newCounterpartPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}
}
$_type | string Default: "BotDialogMessageEvent" Value: "BotDialogMessageEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
dialogToken | string Token for this dialog. It is present in every dialog webhook and must be passed to all Bot Web-API service calls to identify the dialog. |
any (MessageData) Base class for all conversation messages. Can be one of |
{- "$_type": "BotDialogMessageEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "dialogToken": "string",
- "conversationMessage": {
- "$_type": "ApprovalRequestMessageData",
- "id": "string",
- "conversationId": "string",
- "externalMessengerChannelId": "string",
- "accountId": "string",
- "senderPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "senderPersonPresenceId": "string",
- "serverTimestamp": 0,
- "sendTimestamp": 0,
- "type": "TEXT",
- "recipientPersonIds": [
- "string"
], - "fallbackText": "string",
- "actionId": "string",
- "sourceId": "string",
- "text": "string",
- "textType": "SIMPLE_TEXT",
- "options": [
- {
- "$_type": "MultichoiceQuestionOption",
- "label": "string",
- "value": "string",
- "primary": true
}
], - "answerStatus": "PENDING"
}
}
$_type | string Default: "BotDialogMessageStateEvent" Value: "BotDialogMessageStateEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
dialogToken | string Token for this dialog. It is present in every dialog webhook and must be passed to all Bot Web-API service calls to identify the dialog. |
messageId | string The id of the message which state has changed |
state | string (EMessageState) Enum: "DELIVERED" "READ" enum-descriptions: ["DELIVERED: The message was delivered to the recipients","READ: The message was read by the recipients"] The state of a message if it was delivered or read |
botPersonId | string The id if the bot who send the message |
conversationId | string The conversation to which the message belongs to |
{- "$_type": "BotDialogMessageStateEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "dialogToken": "string",
- "messageId": "string",
- "state": "DELIVERED",
- "botPersonId": "string",
- "conversationId": "string"
}
$_type | string Default: "BotDialogOpenEvent" Value: "BotDialogOpenEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
dialogToken | string Token for this dialog. It is present in every dialog webhook and must be passed to all Bot Web-API service calls to identify the dialog. |
dialogType | string (EBotDialogType) Enum: "ONBOARDING" "REBOARDING" "OFFBOARDING" enum-descriptions: ["ONBOARDING","REBOARDING","OFFBOARDING"] Type of a bot dialog |
object (PersonData) Representation of a Person (Agent or Visitor). | |
object (ConversationData) Metadata information about a conversation |
{- "$_type": "BotDialogOpenEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "dialogToken": "string",
- "dialogType": "ONBOARDING",
- "counterpartPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "conversation": {
- "$_type": "ConversationData",
- "creationTimestamp": 0,
- "endTimestamp": 0,
- "id": "string",
- "accountId": "string",
- "topic": "string",
- "recipient": {
- "$_type": "AccountData",
- "id": "string",
- "displayName": "string",
- "avatar": "string"
}, - "participants": [
- {
- "$_type": "ParticipantData",
- "state": "CREATED",
- "personId": "string",
- "connectedViaExternalMessenger": true,
- "hidden": true,
- "conversationStarred": true
}
], - "assigneePersonId": "string",
- "contextPersonId": "string",
- "state": "CREATED",
- "initialEngagementType": "CHAT_REQUEST",
- "locale": "string",
- "tokboxSessionId": "string",
- "visitorData": "string",
- "conversationTemplateId": "string",
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
], - "externalMessengerChannelId": "string",
- "sourceId": "string",
- "endReason": "ENDED_BY_PARTICIPANT",
- "initialEngagementUrl": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
}
$_type | string Default: "BotDialogPostMessage" Value: "BotDialogPostMessage" |
dialogToken | string The token belonging to the dialog the bot wants the message to |
any (PostMessageData) Base class for all conversation messages send to the collaboration server. |
{- "$_type": "BotDialogPostMessage",
- "dialogToken": "string",
- "messageData": {
- "$_type": "ListPostMessageData",
- "type": "TEXT",
- "fallbackText": "string",
- "header": {
- "$_type": "MessageHeader",
- "imageUrl": "string",
- "imageAltText": "string",
- "title": "string",
- "body": "string",
- "bodyTextType": "SIMPLE_TEXT"
}, - "items": [
- {
- "$_type": "PostListMessageCardItemData",
- "imageUrl": "string",
- "imageAltText": "string",
- "title": "string",
- "body": "string",
- "bodyTextType": "SIMPLE_TEXT",
- "action": {
- "$_type": "MessageAction",
- "actionType": "LINK_INTERNAL",
- "label": "string",
- "value": "string"
}
}
], - "actions": [
- {
- "$_type": "MessageAction",
- "actionType": "LINK_INTERNAL",
- "label": "string",
- "value": "string"
}
], - "quickReplies": [
- {
- "$_type": "QuickReply",
- "text": "string"
}
]
}
}
$_type | string Default: "BotOffboardingOfferEvent" Value: "BotOffboardingOfferEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
offboardingToken | string The unique offboarding token for this bot used to identify this offboarding via the bot web API. |
object (PersonData) Representation of a Person (Agent or Visitor). | |
offboardingReason | string (EOffboardingReason) Enum: "FORWARDED" "PARTICIPANT_LEFT" "REMOVED_AFTER_TIMEOUT" "ONBOARDING_DECLINED" "ONBOARDING_TIMEOUT" "ONBOARDING_IDLE_TIMEOUT" "KICKED" "CONVERSATION_UNASSIGNED" "EXTERNAL_CHANNEL_CLOSED" "CONVERSATION_ENDED" "SOLVED_BY_BOT" "CONVERSATION_REQUEUED" "OTHER" enum-descriptions: ["FORWARDED: Conversation was forwarded to another agent and this agent therefore left the conversation","PARTICIPANT_LEFT: The participant left the conversation by himself","REMOVED_AFTER_TIMEOUT: The participant was removed from the conversation as he had a connection timeout","ONBOARDING_DECLINED: The onboarding was declined and therefore the participant will not join the conversation","ONBOARDING_TIMEOUT: The onboarding took too long and therefore the participant will not join the conversation","ONBOARDING_IDLE_TIMEOUT: The onboarding timed out and therefore the participant will not join the conversation","KICKED: The participant was kicked out of the conversation","CONVERSATION_UNASSIGNED: The conversation is no longer assigned to an agent and therefore all other agents were removed","EXTERNAL_CHANNEL_CLOSED: The external channel connected to this conversation has closed, no further messages are possible.","CONVERSATION_ENDED: The conversation has ended","SOLVED_BY_BOT: The conversation was ended because an onboarding bot solved it.","CONVERSATION_REQUEUED: The conversation has been re-queued.","OTHER: Some other unspecified reason"] Reason why the offboarding from a conversation was triggered for an individual person. |
object (ConversationData) Metadata information about a conversation |
{- "$_type": "BotOffboardingOfferEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "offboardingToken": "string",
- "offboardingPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "offboardingReason": "FORWARDED",
- "conversation": {
- "$_type": "ConversationData",
- "creationTimestamp": 0,
- "endTimestamp": 0,
- "id": "string",
- "accountId": "string",
- "topic": "string",
- "recipient": {
- "$_type": "AccountData",
- "id": "string",
- "displayName": "string",
- "avatar": "string"
}, - "participants": [
- {
- "$_type": "ParticipantData",
- "state": "CREATED",
- "personId": "string",
- "connectedViaExternalMessenger": true,
- "hidden": true,
- "conversationStarred": true
}
], - "assigneePersonId": "string",
- "contextPersonId": "string",
- "state": "CREATED",
- "initialEngagementType": "CHAT_REQUEST",
- "locale": "string",
- "tokboxSessionId": "string",
- "visitorData": "string",
- "conversationTemplateId": "string",
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
], - "externalMessengerChannelId": "string",
- "sourceId": "string",
- "endReason": "ENDED_BY_PARTICIPANT",
- "initialEngagementUrl": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
}
$_type | string Default: "BotOnboardingOfferEvent" Value: "BotOnboardingOfferEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
onboardingToken | string The unique onboarding token for this bot used to identify this onboarding via the bot web API. |
object (PersonData) Representation of a Person (Agent or Visitor). | |
object (ConversationData) Metadata information about a conversation |
{- "$_type": "BotOnboardingOfferEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "onboardingToken": "string",
- "onboardingPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "conversation": {
- "$_type": "ConversationData",
- "creationTimestamp": 0,
- "endTimestamp": 0,
- "id": "string",
- "accountId": "string",
- "topic": "string",
- "recipient": {
- "$_type": "AccountData",
- "id": "string",
- "displayName": "string",
- "avatar": "string"
}, - "participants": [
- {
- "$_type": "ParticipantData",
- "state": "CREATED",
- "personId": "string",
- "connectedViaExternalMessenger": true,
- "hidden": true,
- "conversationStarred": true
}
], - "assigneePersonId": "string",
- "contextPersonId": "string",
- "state": "CREATED",
- "initialEngagementType": "CHAT_REQUEST",
- "locale": "string",
- "tokboxSessionId": "string",
- "visitorData": "string",
- "conversationTemplateId": "string",
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
], - "externalMessengerChannelId": "string",
- "sourceId": "string",
- "endReason": "ENDED_BY_PARTICIPANT",
- "initialEngagementUrl": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
}
$_type | string Default: "BotPostMessage" Value: "BotPostMessage" |
conversationId | string The id of the conversation to which this message belongs to |
senderPersonId | string ID of the bot person that sent the message. |
recipientPersonIds | Array of strings Person IDs of the recipients of the message. If it is null, all active participations are recipients |
any (PostMessageData) Base class for all conversation messages send to the collaboration server. |
{- "$_type": "BotPostMessage",
- "conversationId": "string",
- "senderPersonId": "string",
- "recipientPersonIds": [
- "string"
], - "messageData": {
- "$_type": "ListPostMessageData",
- "type": "TEXT",
- "fallbackText": "string",
- "header": {
- "$_type": "MessageHeader",
- "imageUrl": "string",
- "imageAltText": "string",
- "title": "string",
- "body": "string",
- "bodyTextType": "SIMPLE_TEXT"
}, - "items": [
- {
- "$_type": "PostListMessageCardItemData",
- "imageUrl": "string",
- "imageAltText": "string",
- "title": "string",
- "body": "string",
- "bodyTextType": "SIMPLE_TEXT",
- "action": {
- "$_type": "MessageAction",
- "actionType": "LINK_INTERNAL",
- "label": "string",
- "value": "string"
}
}
], - "actions": [
- {
- "$_type": "MessageAction",
- "actionType": "LINK_INTERNAL",
- "label": "string",
- "value": "string"
}
], - "quickReplies": [
- {
- "$_type": "QuickReply",
- "text": "string"
}
]
}
}
$_type | string Default: "BotReboardingOfferEvent" Value: "BotReboardingOfferEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
reboardingToken | string The token reboarding token for this bot used to identify this reboarding via the bot web API. |
object (PersonData) Representation of a Person (Agent or Visitor). | |
object (ConversationData) Metadata information about a conversation |
{- "$_type": "BotReboardingOfferEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "reboardingToken": "string",
- "reboardingPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "conversation": {
- "$_type": "ConversationData",
- "creationTimestamp": 0,
- "endTimestamp": 0,
- "id": "string",
- "accountId": "string",
- "topic": "string",
- "recipient": {
- "$_type": "AccountData",
- "id": "string",
- "displayName": "string",
- "avatar": "string"
}, - "participants": [
- {
- "$_type": "ParticipantData",
- "state": "CREATED",
- "personId": "string",
- "connectedViaExternalMessenger": true,
- "hidden": true,
- "conversationStarred": true
}
], - "assigneePersonId": "string",
- "contextPersonId": "string",
- "state": "CREATED",
- "initialEngagementType": "CHAT_REQUEST",
- "locale": "string",
- "tokboxSessionId": "string",
- "visitorData": "string",
- "conversationTemplateId": "string",
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
], - "externalMessengerChannelId": "string",
- "sourceId": "string",
- "endReason": "ENDED_BY_PARTICIPANT",
- "initialEngagementUrl": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
}
dialogOfferToken | string the onboarding-, reboarding- or offboarding-offer token contained in the webhook. |
{- "dialogOfferToken": "string"
}
dialogToken | string The token belonging to the dialog |
{- "dialogToken": "string"
}
conversationId | string The ID of the conversation the question message was sent to |
questionMessageId | string The ID of the question message that will be cancelled |
{- "conversationId": "string",
- "questionMessageId": "string"
}
dialogOfferToken | string the onboarding-, reboarding- or offboarding-offer token contained in the webhook. |
{- "dialogOfferToken": "string"
}
dialogToken | string The token belonging to the dialog of the bot |
messageId | string The ID of the delivered message |
{- "dialogToken": "string",
- "messageId": "string"
}
dialogToken | string The token belonging to the dialog of the bot |
messageId | string The ID of the message that was read |
{- "dialogToken": "string",
- "messageId": "string"
}
dialogToken | string The dialog token contained in each bot dialog webhook. |
reason | string (EBotDialogFinishReason) Enum: "HAND_OFF" "SOLVED" "ABORTED" enum-descriptions: ["HAND_OFF: The bot is done with his part and the next bot can to the on-, re- or offboarding.","SOLVED: The problem of the dialog was solved and therefore no further bots are invoked.","ABORTED: The dialog was not successful and the on-, re- or offboarding has to be aborted."] Reason why a bot finished a dialog. |
{- "dialogToken": "string",
- "reason": "HAND_OFF"
}
$_type | string Default: "CannedResponse" Value: "CannedResponse" |
id | string Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway. |
creationTimestamp | integer <int64> Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
modificationTimestamp | integer <int64> Timestamp of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
version | integer <int64> Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted. |
accountId | string Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
ownerId | string Id of the owner of the entity. Can not be omitted. |
ownerType | string (EPropertyOwnerType) Enum: "GLOBAL" "ACCOUNT" "TEAM" "USER" "AREA" "APIKEY" "PERSON" "CONVERSATION" "CONVERSATION_TEMPLATE" "EXTERNAL_MESSENGER_CHANNEL" enum-descriptions: ["GLOBAL: Global system is owner","ACCOUNT: Account is owner","TEAM: Team is owner","USER: User is owner","AREA: NamedArea is owner","APIKEY: ApiKey is owner","PERSON: Person","CONVERSATION: Conversation","CONVERSATION_TEMPLATE: Conversation template","EXTERNAL_MESSENGER_CHANNEL: External messenger channel"] Type of an owner of an entity |
key | string The key of a canned response to access it quickly. Maximum of 250 characters. Can not be omitted. |
title | string The title of a canned response. Maximum of 250 characters. Can be omitted, but should not. |
text | string The text of a canned response. Can be omitted, but should not. |
{- "$_type": "CannedResponse",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "ownerId": "string",
- "ownerType": "GLOBAL",
- "key": "string",
- "title": "string",
- "text": "string"
}
$_type | string Default: "CannedResponseConfigurationScope" Value: "CannedResponseConfigurationScope" |
name | string Name of the scope |
ownerId | string Id of the owner. It defines to whom the configuration is assigned |
ownerType | string (EPropertyOwnerType) Enum: "GLOBAL" "ACCOUNT" "TEAM" "USER" "AREA" "APIKEY" "PERSON" "CONVERSATION" "CONVERSATION_TEMPLATE" "EXTERNAL_MESSENGER_CHANNEL" enum-descriptions: ["GLOBAL: Global system is owner","ACCOUNT: Account is owner","TEAM: Team is owner","USER: User is owner","AREA: NamedArea is owner","APIKEY: ApiKey is owner","PERSON: Person","CONVERSATION: Conversation","CONVERSATION_TEMPLATE: Conversation template","EXTERNAL_MESSENGER_CHANNEL: External messenger channel"] Type of an owner of an entity |
{- "$_type": "CannedResponseConfigurationScope",
- "name": "string",
- "ownerId": "string",
- "ownerType": "GLOBAL"
}
$_type | string Default: "CannedResponseOrderBy" Value: "CannedResponseOrderBy" |
field | string (ECannedResponseOrderByField) Enum: "ID" "KEY" "TITLE" "TEXT" "OWNER_TYPE" "OWNER_ID" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["ID: Sort by the 'id' attribute","KEY: Sort by the 'key' attribute","TITLE: Sort by the 'title' attribute","TEXT: Sort by the 'text' attribute","OWNER_TYPE: Sort by the 'ownerType' attribute","OWNER_ID: Sort by the 'ownerId' attribute","CREATION_TIMESTAMP: Sort by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Sort by the 'modificationTimestamp' attribute"] |
order | string (Order) Enum: "ASCENDING" "DESCENDING" enum-descriptions: ["ASCENDING: Sort in the ascending order (smallest to largest, 0 to 9, and/or A to Z)","DESCENDING: Sort in the descending order (largest to smallest, 9 to 0, and/or Z to A)"] |
{- "$_type": "CannedResponseOrderBy",
- "field": "ID",
- "order": "ASCENDING"
}
$_type | string Default: "CannedResponseQuery" Value: "CannedResponseQuery" |
Array of any (CannedResponseSearchFilter) [ items ] List of filters to narrow the search of entities | |
Array of objects (CannedResponseOrderBy) [ items ] List of criteria to order the search result list | |
offset | integer <int32> Offset position in the result set to start pagination |
limit | integer <int32> Maximal amount of items returned |
{- "$_type": "CannedResponseQuery",
- "searchFilters": [
- {
- "$_type": "CreationTimestampCannedResponseSearchFilter",
- "field": "KEY",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
], - "orderBy": [
- {
- "$_type": "CannedResponseOrderBy",
- "field": "ID",
- "order": "ASCENDING"
}
], - "offset": 0,
- "limit": 0
}
$_type | string Default: "CannedResponseResult" Value: "CannedResponseResult" |
hasMoreItems | boolean Flag to indicate if there are more items on the server |
nextOffset | integer <int32> If more items are present on the server, this value can be used as offset in the next query |
Array of objects (CannedResponse) [ items ] The returned list of entities |
{- "$_type": "CannedResponseResult",
- "hasMoreItems": true,
- "nextOffset": 0,
- "items": [
- {
- "$_type": "CannedResponse",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "ownerId": "string",
- "ownerType": "GLOBAL",
- "key": "string",
- "title": "string",
- "text": "string"
}
]
}
$_type | string Default: "CreationTimestampCannedResponseSearchFilter" Value: "CreationTimestampCannedResponseSearchFilter" |
field | string (ECannedResponseSearchFilterField) enum-descriptions: ["KEY: Filter by the 'key' attribute","TITLE: Filter by the 'title' attribute","TEXT: Filter by the 'text' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] CREATION_TIMESTAMP KEY TITLE TEXT CREATION_TIMESTAMP MODIFICATION_TIMESTAMP |
any (TimestampOperator) |
{- "$_type": "CreationTimestampCannedResponseSearchFilter",
- "field": "CREATION_TIMESTAMP",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
$_type | string Default: "CardMessageData" Value: "CardMessageData" |
id | string The ID of the message. |
conversationId | string Conversation ID to which this message belongs to |
externalMessengerChannelId | string ID of the external messenger channel connected to the conversation. Null if the conversation is not connected to an external messenger. |
accountId | string Account ID to which this message and conversation belongs to. |
object (PersonData) Representation of a Person (Agent or Visitor). | |
senderPersonPresenceId | string Id of the person presence that sends the message. May be null if the message was sent by the system. |
serverTimestamp | integer <int64> utc timestamp when the message was received on the server. |
sendTimestamp | integer <int64> utc timestamp when the message was sent from the client |
type | string (EMessageType) Enum: "TEXT" "FILE" "CARD" "LIST" "APPROVAL_REQUEST" "MULTICHOICE_QUESTION" "RATING_QUESTION" "TEXT_QUESTION" "REPLY" "QUESTION_ABORTED" enum-descriptions: ["TEXT","FILE","CARD","LIST","APPROVAL_REQUEST","MULTICHOICE_QUESTION","RATING_QUESTION","TEXT_QUESTION","REPLY","QUESTION_ABORTED"] The message type of a conversation message |
recipientPersonIds | Array of strings Person IDs of the recipients of the message. If it is null, all active participations are recipients |
fallbackText | string Text representation of the message which is used in following cases:
The fallback text can be provided by the sender (bot, external messenger) or is generated when missing. This may however not always be a perfect textual representation of the message. |
actionId | string An ID of the action triggering the message to be able to identify a message created by an action. |
sourceId | string A custom ID which identifies where this message initially came from. |
imageUrl | string URL of the image displayed at the top of the card. |
imageAltText | string Alt text for the image. |
title | string Title displayed bold below the image. |
body | string Body text which may optionally contain markdown. |
bodyTextType | string (EConversationMessageTextType) Enum: "SIMPLE_TEXT" "MARKDOWN" enum-descriptions: ["SIMPLE_TEXT: Text will be interpreted as simple text. <p> Auto link detection will still be possible.","MARKDOWN: Text will be interpreted as Markdown. <p> The supported Markdown subset depends on the message type."] How text in a conversation message should be interpreted. |
Array of objects (MessageAction) [ items ] Actions which will be displayed at the bottom of the card. | |
Array of objects (QuickReply) [ items ] Optional quick replies which will be displayed above the chat input as a possible response options |
{- "$_type": "CardMessageData",
- "id": "string",
- "conversationId": "string",
- "externalMessengerChannelId": "string",
- "accountId": "string",
- "senderPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "senderPersonPresenceId": "string",
- "serverTimestamp": 0,
- "sendTimestamp": 0,
- "type": "TEXT",
- "recipientPersonIds": [
- "string"
], - "fallbackText": "string",
- "actionId": "string",
- "sourceId": "string",
- "imageUrl": "string",
- "imageAltText": "string",
- "title": "string",
- "body": "string",
- "bodyTextType": "SIMPLE_TEXT",
- "actions": [
- {
- "$_type": "MessageAction",
- "actionType": "LINK_INTERNAL",
- "label": "string",
- "value": "string"
}
], - "quickReplies": [
- {
- "$_type": "QuickReply",
- "text": "string"
}
]
}
$_type | string Default: "CardPostMessageData" Value: "CardPostMessageData" |
type | string (EPostMessageType) Enum: "TEXT" "FILE" "CARD" "LIST" "MULTICHOICE_QUESTION" "RATING_QUESTION" "TEXT_QUESTION" "REPLY" enum-descriptions: ["TEXT: See `TextPostMessageData`","FILE: See `FilePostMessageData`","CARD: See `CardPostMessageData`","LIST: See `ListPostMessageData`","MULTICHOICE_QUESTION: See `MultichoiceQuestionPostMessageData`","RATING_QUESTION: See `RatingQuestionPostMessageData`","TEXT_QUESTION: See `TextQuestionPostMessageData`","REPLY: See `ReplyPostMessageData`"] Type of a message which is send to the collaboration server |
fallbackText | string Optional fallback text which is used when:
The value must not contain markdown. If no fallback is given, a fallback text based on the content of the message is generated. This may however not always be a perfect textual representation of the message. |
imageUrl | string URL of the image displayed at the top of the card. (optional)
|
imageAltText | string Alt text for the image. (required if imageUrl is set) |
title | string Title displayed below the image. (optional) Max length is 64 characters. |
body | string Body text which may optionally contain markdown. (optional) Max length is 640 characters. |
bodyTextType | string (EConversationMessageTextType) Enum: "SIMPLE_TEXT" "MARKDOWN" enum-descriptions: ["SIMPLE_TEXT: Text will be interpreted as simple text. <p> Auto link detection will still be possible.","MARKDOWN: Text will be interpreted as Markdown. <p> The supported Markdown subset depends on the message type."] How text in a conversation message should be interpreted. |
Array of objects (MessageAction) [ items ] Actions which will be displayed at the bottom of the card. (optional) Max number of actions is 5. | |
Array of objects (QuickReply) [ items ] Optional list of quick replies available to the message's recipients Max number of quick replies is 13. |
{- "$_type": "CardPostMessageData",
- "type": "TEXT",
- "fallbackText": "string",
- "imageUrl": "string",
- "imageAltText": "string",
- "title": "string",
- "body": "string",
- "bodyTextType": "SIMPLE_TEXT",
- "actions": [
- {
- "$_type": "MessageAction",
- "actionType": "LINK_INTERNAL",
- "label": "string",
- "value": "string"
}
], - "quickReplies": [
- {
- "$_type": "QuickReply",
- "text": "string"
}
]
}
$_type | string Default: "CompactUser" Value: "CompactUser" |
id | string Id of the user |
accountId | string Account id of the user |
username | string username for login |
displayName | string Displayed name of the user |
firstName | string First name of the user |
lastName | string Last name of the user |
string or Avatar (object) expand-query-key: avatar type: ExpandableField Avatar of the user: id that can be expanded. | |
teamId | string id of the team the user belongs to |
parentTeamIds | Array of strings Ids of the parent teams. That are recursively the parent team of each parent team |
object (Permissions) Container for permissions of a user | |
authorizationRole | string (EAuthorizationRole) Enum: "SUPER_ADMIN" "PARTNER" "TECHNICAL_ADMIN" "ADMIN" "SUPERVISOR" "REGISTERED_USER" "WEBUSER" "ANONYMOUS_USER" enum-descriptions: ["SUPER_ADMIN: Super admin role. Only for unblu or system admins","PARTNER: Partner role. (no longer used)","TECHNICAL_ADMIN: Technical admin role.","ADMIN: Admin role. For Admins of the system","SUPERVISOR: Supervisor role. For users which manage teams","REGISTERED_USER: User role. For normal users (agents)","WEBUSER: Webuser role. For internal representation of users from the outside","ANONYMOUS_USER: Anonymous role. For internal representation of unknown users"] The authorization role is mainly used for access definition of a service |
passwordDefined | boolean True if the user has a password defined |
virtual | boolean True if the user is virtual |
propagated | boolean True if the user is propagated (did not log in locally but identity was propagateds); |
impersonatedFromUserId | string id of the user from which the impersonation was initiated. Null if no impersonation is used. |
impersonatedFromAccountId | string id of the account from which the impersonation was initiated. Null if no impersonation is used. |
{- "$_type": "CompactUser",
- "id": "string",
- "accountId": "string",
- "username": "string",
- "displayName": "string",
- "firstName": "string",
- "lastName": "string",
- "avatar": "string",
- "teamId": "string",
- "parentTeamIds": [
- "string"
], - "permissions": {
- "$_type": "Permissions",
- "allPermissions": true,
- "permissions": [
- "string"
]
}, - "authorizationRole": "SUPER_ADMIN",
- "passwordDefined": true,
- "virtual": true,
- "propagated": true,
- "impersonatedFromUserId": "string",
- "impersonatedFromAccountId": "string"
}
$_type | string Default: "Contact" Value: "Contact" |
id | string Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway. |
creationTimestamp | integer <int64> Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
modificationTimestamp | integer <int64> Timestamp of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
version | integer <int64> Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted. |
accountId | string Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
ownerId | string Id of the owner of the entity. Can not be omitted. |
ownerType | string (EPropertyOwnerType) Enum: "GLOBAL" "ACCOUNT" "TEAM" "USER" "AREA" "APIKEY" "PERSON" "CONVERSATION" "CONVERSATION_TEMPLATE" "EXTERNAL_MESSENGER_CHANNEL" enum-descriptions: ["GLOBAL: Global system is owner","ACCOUNT: Account is owner","TEAM: Team is owner","USER: User is owner","AREA: NamedArea is owner","APIKEY: ApiKey is owner","PERSON: Person","CONVERSATION: Conversation","CONVERSATION_TEMPLATE: Conversation template","EXTERNAL_MESSENGER_CHANNEL: External messenger channel"] Type of an owner of an entity |
type | string (EContactType) Enum: "UNKNOWN_PHONE" "MOBILE_PHONE" "FIXNET_PHONE" "EMAIL" "URL" enum-descriptions: ["UNKNOWN_PHONE: Any phone number (fixnet, mobile,...)","MOBILE_PHONE: Mobile phone number","FIXNET_PHONE: Fixnet phone number","EMAIL: email address","URL: Url (e.g. company homepage url)"] Type of a contact information |
data | string The data of the contact information. e.g. a phone number. It is used for presentation. Can not be omitted. |
rawData | string The raw data of the contact information. In most cases it is the same as the data field. Can not be omitted. |
{- "$_type": "Contact",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "ownerId": "string",
- "ownerType": "GLOBAL",
- "type": "UNKNOWN_PHONE",
- "data": "string",
- "rawData": "string"
}
$_type | string Default: "ContactOrderBy" Value: "ContactOrderBy" |
field | string (EContactOrderByField) Enum: "ID" "TYPE" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["ID: Sort by the 'id' attribute","TYPE: Sort by the 'type' attribute","CREATION_TIMESTAMP: Sort by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Sort by the 'modificationTimestamp' attribute"] |
order | string (Order) Enum: "ASCENDING" "DESCENDING" enum-descriptions: ["ASCENDING: Sort in the ascending order (smallest to largest, 0 to 9, and/or A to Z)","DESCENDING: Sort in the descending order (largest to smallest, 9 to 0, and/or Z to A)"] |
{- "$_type": "ContactOrderBy",
- "field": "ID",
- "order": "ASCENDING"
}
$_type | string Default: "ContactQuery" Value: "ContactQuery" |
Array of any (ContactSearchFilter) [ items ] List of filters to narrow the search of entities | |
Array of objects (ContactOrderBy) [ items ] List of criteria to order the search result list | |
offset | integer <int32> Offset position in the result set to start pagination |
limit | integer <int32> Maximal amount of items returned |
{- "$_type": "ContactQuery",
- "searchFilters": [
- {
- "$_type": "CreationTimestampContactSearchFilter",
- "field": "CREATION_TIMESTAMP",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
], - "orderBy": [
- {
- "$_type": "ContactOrderBy",
- "field": "ID",
- "order": "ASCENDING"
}
], - "offset": 0,
- "limit": 0
}
$_type | string Default: "ContactResult" Value: "ContactResult" |
hasMoreItems | boolean Flag to indicate if there are more items on the server |
nextOffset | integer <int32> If more items are present on the server, this value can be used as offset in the next query |
Array of objects (Contact) [ items ] The returned list of entities |
{- "$_type": "ContactResult",
- "hasMoreItems": true,
- "nextOffset": 0,
- "items": [
- {
- "$_type": "Contact",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "ownerId": "string",
- "ownerType": "GLOBAL",
- "type": "UNKNOWN_PHONE",
- "data": "string",
- "rawData": "string"
}
]
}
$_type | string Default: "CreationTimestampContactSearchFilter" Value: "CreationTimestampContactSearchFilter" |
field | string (EContactSearchFilterField) enum-descriptions: ["CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] CREATION_TIMESTAMP CREATION_TIMESTAMP MODIFICATION_TIMESTAMP |
any (TimestampOperator) |
{- "$_type": "CreationTimestampContactSearchFilter",
- "field": "CREATION_TIMESTAMP",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
$_type | string Default: "ContainsStringOperator" Value: "ContainsStringOperator" |
type | string (EStringOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" "IS_NULL" "IS_NOT_NULL" "CONTAINS" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator","IS_NULL: Check if the value is null","IS_NOT_NULL: Check if the value is not null","CONTAINS: Check if the value contains the string provided in the operator"] |
value | string |
{- "$_type": "ContainsStringOperator",
- "type": "EQUALS",
- "value": "string"
}
$_type | string Default: "ContextPersonIdConversationSearchFilter" Value: "ContextPersonIdConversationSearchFilter" |
field | string (EConversationSearchFilterField) Enum: "CREATION_TIMESTAMP" "END_TIMESTAMP" "INITIAL_ENGAGEMENT_TYPE" "TOPIC" "CONTEXT_PERSON_ID" "ASSIGNEE_PERSON_ID" "PARTICIPANT_PERSON_ID" "STATE" "END_REASON" "CONVERSATION_TEMPLATE_ID" "RECIPIENT_ID" "RECIPIENT_TYPE" "TOKBOX_SESSION_ID" enum-descriptions: ["CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","END_TIMESTAMP: Filter by the 'endTimestamp' attribute","INITIAL_ENGAGEMENT_TYPE: Filter by the 'initialEngagementType' attribute","TOPIC: Filter by the 'topic' attribute","CONTEXT_PERSON_ID: Filter by the 'contextPersonId' attribute","ASSIGNEE_PERSON_ID: Filter by the 'assigneePersonId' attribute","PARTICIPANT_PERSON_ID: Filter by the 'personId' of the participants","STATE: Filter by the 'state' attribute","END_REASON: Filter by the 'endReason' attribute","CONVERSATION_TEMPLATE_ID: Filter by the 'conversationTemplateId' attribute","RECIPIENT_ID: Filter by the 'id' of the 'recipient' attribute","RECIPIENT_TYPE: Filter by the 'type' of the 'recipient' attribute","TOKBOX_SESSION_ID: Filter by the 'tokboxSessionId' attribute"] |
any (IdOperator) Defines operators used for comparing id fields in tables. |
{- "$_type": "ContextPersonIdConversationSearchFilter",
- "field": "CREATION_TIMESTAMP",
- "operator": {
- "$_type": "EqualsIdOperator",
- "type": "EQUALS",
- "value": "string"
}
}
$_type | string Default: "ContextPersonInfo" Value: "ContextPersonInfo" |
id | string Unique id of the person, when creating a person this property can be omitted as it will be generated by the server anyway. |
accountId | string Account id to which a Person belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
personSource | string (EPersonSource) Enum: "USER_DB" "VIRTUAL" enum-descriptions: ["USER_DB: Person-Source is on the main_user table","VIRTUAL: Person-Source is only virtual (no seperate storage)"] The source type of a person (participant of a conversation) |
sourceId | string Identifier of the person in its source (defined by |
sourceData | string Vendor specific data. |
firstName | string The first name of the person. Maximum length of 250 characters. Can be omitted. |
lastName | string the last name of the person. Maximum length of 250 characters. Can be omitted. |
username | string The username of the person. When firstName and lastName are unknown, it is recommended to use this value to change the displayName. Depending on the configuration, this is may also be the email of the corresponding user. Maximum length of 250 characters. Can be omitted. |
nickname | string A name that an anonymous person has given itself. Maximum length of 250 characters. Can be omitted. |
displayName | string Display name of the person. This is read only information, it will be set by the server anyway. |
personType | string (EPersonType) Enum: "AGENT" "VISITOR" "SYSTEM" "BOT" enum-descriptions: ["AGENT: Agent participant","VISITOR: Visitor participant","SYSTEM: System participant","BOT: Bot participant"] The type of a person (participant of a session) |
authorizationRole | string (EAuthorizationRole) Enum: "SUPER_ADMIN" "PARTNER" "TECHNICAL_ADMIN" "ADMIN" "SUPERVISOR" "REGISTERED_USER" "WEBUSER" "ANONYMOUS_USER" enum-descriptions: ["SUPER_ADMIN: Super admin role. Only for unblu or system admins","PARTNER: Partner role. (no longer used)","TECHNICAL_ADMIN: Technical admin role.","ADMIN: Admin role. For Admins of the system","SUPERVISOR: Supervisor role. For users which manage teams","REGISTERED_USER: User role. For normal users (agents)","WEBUSER: Webuser role. For internal representation of users from the outside","ANONYMOUS_USER: Anonymous role. For internal representation of unknown users"] The authorization role is mainly used for access definition of a service |
string The email of the person. Optional. | |
phone | string The phone of the person. Optional. |
teamId | string Team id of the person. Optional. |
teamName | string Team name of the person, only present when the team id is set. When creating or updating a person this property can be omitted as it will be set by the server anyway. |
string or Avatar (object) expand-query-key: avatar type: ExpandableField Avatar of the entity: id that can be expanded. | |
osName | string The operation system name of the visitors computer |
osVersion | string The version of the operation system of the visitors computer |
browserName | string The name of the browser the visitor uses |
browserVersion | string The version of the browser the visitor uses |
locale | string The locale defined in the browser of the visitor (BCP 47 language tag form including region if available) |
city | string The city in which the visitor is (probably) |
country | string The country in which the visitor is (probable) |
{- "$_type": "ContextPersonInfo",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "osName": "string",
- "osVersion": "string",
- "browserName": "string",
- "browserVersion": "string",
- "locale": "string",
- "city": "string",
- "country": "string"
}
$_type | string Default: "ConversationCreatedEvent" Value: "ConversationCreatedEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
object (ConversationData) Metadata information about a conversation |
{- "$_type": "ConversationCreatedEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "conversation": {
- "$_type": "ConversationData",
- "creationTimestamp": 0,
- "endTimestamp": 0,
- "id": "string",
- "accountId": "string",
- "topic": "string",
- "recipient": {
- "$_type": "AccountData",
- "id": "string",
- "displayName": "string",
- "avatar": "string"
}, - "participants": [
- {
- "$_type": "ParticipantData",
- "state": "CREATED",
- "personId": "string",
- "connectedViaExternalMessenger": true,
- "hidden": true,
- "conversationStarred": true
}
], - "assigneePersonId": "string",
- "contextPersonId": "string",
- "state": "CREATED",
- "initialEngagementType": "CHAT_REQUEST",
- "locale": "string",
- "tokboxSessionId": "string",
- "visitorData": "string",
- "conversationTemplateId": "string",
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
], - "externalMessengerChannelId": "string",
- "sourceId": "string",
- "endReason": "ENDED_BY_PARTICIPANT",
- "initialEngagementUrl": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
}
$_type | string Default: "ConversationData" Value: "ConversationData" |
creationTimestamp | integer <int64> Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. |
endTimestamp | integer <int64> utc timestamp when the conversation has ended (all participants have finished their offboarding). |
id | string Unique id of the conversation. When creating an entity this property can be omitted as it will be generated by the server anyway. |
accountId | string Account id to which the conversation belongs to. When creating a conversation, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
topic | string Topic of the conversation. Can be omitted. |
any (ConversationRecipientData) Recipient of a conversation: Either a single | |
Array of objects (ParticipantData) [ items ] Current participants of the conversation | |
assigneePersonId | string PersonId of the assignee, must be one of the participants |
contextPersonId | string PersonId of the main visitor, must be one of the participants |
state | string (EConversationState) Enum: "CREATED" "ONBOARDING" "REBOARDING" "QUEUED" "ACTIVE" "UNASSIGNED" "OFFBOARDING" "ENDED" enum-descriptions: ["CREATED: Initial state of a conversation","ONBOARDING: Depending of the engagement type of the conversation, the conversation stays in the onboarding state as long as the person in the center of the conversation is doing his onboarding","REBOARDING: When a message is send to an unassigned conversation, the conversation first is put into the reboarding state as long as the person in the center of the conversation is doing the reboarding.","QUEUED: Depending of the engagement type of the conversation, the conversation is put in the queued state when it is inside the queue.","ACTIVE: Conversation is active","UNASSIGNED: After there is no assignee of a conversation anymore, the conversation goes to unassigned state until a message from a visitor is written to start reboarding again.","OFFBOARDING: Conversation is being ended","ENDED: Conversation is ended"] Life cycle state of the conversation. Following transitions are possible:
|
initialEngagementType | string (EInitialEngagementType) Enum: "CHAT_REQUEST" "OFFLINE_CHAT_REQUEST" "VIDEO_REQUEST" "AUDIO_REQUEST" "HEADLESS_BROWSER_REQUEST" "DOMCAP_BROWSER_REQUEST" "MOBILE_COBROWSING_REQUEST" "SCREEN_SHARING_REQUEST" "VISITOR_COBROWSING" "HEADLESS_PIN" "DOMCAP_PIN" "MOBILE_PIN" "SCREEN_SHARING_PIN" "CHAT_INVITE" "HEADLESS_INVITE" "SCREEN_SHARING_INVITE" enum-descriptions: ["CHAT_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming chat conversation.","OFFLINE_CHAT_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming chat conversation while all agents are offline.","VIDEO_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming video conversation.","AUDIO_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming audio conversation.","HEADLESS_BROWSER_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming universal co-browsing conversation.","DOMCAP_BROWSER_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming embedded co-browsing conversation.","MOBILE_COBROWSING_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming mobile co-browsing conversation.","SCREEN_SHARING_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming screen sharing conversation.","VISITOR_COBROWSING: (Api initiated, visitor centered) A visitor creates a conversation via API which is not added to the queue and where he can invite other visitor to do embedded","HEADLESS_PIN: (Agent initiated, visitor centered) An agent creates a conversation with a PIN invitation for the visitor to join an universal co-browsing conversation.","DOMCAP_PIN: (Agent initiated, visitor centered) An agent creates a conversation with a PIN invitation for the visitor to join an embedded co-browsing conversation.","MOBILE_PIN: (Agent initiated, visitor centered) An agent creates a conversation with a PIN invitation for the visitor to join a mobile co-browsing conversation.","SCREEN_SHARING_PIN: (Agent initiated, visitor centered) An agent creates a conversation with a PIN invitation for the visitor to join a screen sharing conversation.","CHAT_INVITE: (Agent initiated, agent centered) An agent creates a chat conversation (this is the recommended initial engagement type for conversation created with the Web API).","HEADLESS_INVITE: (Agent initiated, agent centered) An agent creates universal co-browsing conversation and invites customer later.","SCREEN_SHARING_INVITE: (Agent initiated, agent centered) An agent creates screen sharing conversation and invites customer later."] The initial type of a conversation. The type used at creation time of the conversation determines the conversation template that is used. |
locale | string Locale of the conversation language (as BCP 47 language tag form including region if available) |
tokboxSessionId | string Tokbox sessionId. When creating a conversation this property can be omitted as it will be generated by the server anyway. |
visitorData | string Custom data for the visitor. This has no specific format. |
conversationTemplateId | string Template id of this conversation. If omitted, the default conversationTemplate will be retrieved based on the initialEngagementType |
Array of objects (ConversationLink) [ items ] Links to open the conversation. When creating a conversation this property can be omitted as it will be generated by the server anyway. | |
externalMessengerChannelId | string Id to the external messenger channel the conversation should be linked to. If this property is null the conversation is an Unblu conversation and not linked to a messenger channel. |
sourceId | string Custom id to identify the source of the conversation. Typically this is used in connection to an external messenger to create a link to the external conversation. |
endReason | string (EConversationEndReason) Enum: "ENDED_BY_PARTICIPANT" "MANDATORY_PARTICIPANT_GONE" "EXTERNAL_CHANNEL_CLOSED" "SOLVED_BY_BOT" "OTHER" enum-descriptions: ["ENDED_BY_PARTICIPANT","MANDATORY_PARTICIPANT_GONE","EXTERNAL_CHANNEL_CLOSED","SOLVED_BY_BOT","OTHER"] Closing reason of a conversation |
initialEngagementUrl | string The URL where the conversation was originated. Conversations originated by a visitor where Unblu was integrated in the customers website will have a value. e.g. conversations initiated from the mobile SDK won't have a initial engagement URL. |
object expand-query-key: configuration type: Map The entity's configuration properties. Only contains values when the 'expand' query parameter is used with the value 'configuration'. | |
object expand-query-key: text type: Map The entity's text properties. Only contains values when the 'expand' query parameter is used with the value 'text'. | |
object expand-query-key: metadata type: Map The entity's metadata properties. Only contains values when the 'expand' query parameter is used with the value 'metadata'. |
{- "$_type": "ConversationData",
- "creationTimestamp": 0,
- "endTimestamp": 0,
- "id": "string",
- "accountId": "string",
- "topic": "string",
- "recipient": {
- "$_type": "AccountData",
- "id": "string",
- "displayName": "string",
- "avatar": "string"
}, - "participants": [
- {
- "$_type": "ParticipantData",
- "state": "CREATED",
- "personId": "string",
- "connectedViaExternalMessenger": true,
- "hidden": true,
- "conversationStarred": true
}
], - "assigneePersonId": "string",
- "contextPersonId": "string",
- "state": "CREATED",
- "initialEngagementType": "CHAT_REQUEST",
- "locale": "string",
- "tokboxSessionId": "string",
- "visitorData": "string",
- "conversationTemplateId": "string",
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
], - "externalMessengerChannelId": "string",
- "sourceId": "string",
- "endReason": "ENDED_BY_PARTICIPANT",
- "initialEngagementUrl": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
$_type | string Default: "EqualsConversationEndReasonOperator" Value: "EqualsConversationEndReasonOperator" |
type | string (EConversationEndReasonOperatorType) enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator"] EQUALS NotConversationEndReasonOperator EQUALS NOT_EQUALS IN |
value | string (EConversationEndReason) Enum: "ENDED_BY_PARTICIPANT" "MANDATORY_PARTICIPANT_GONE" "EXTERNAL_CHANNEL_CLOSED" "SOLVED_BY_BOT" "OTHER" enum-descriptions: ["ENDED_BY_PARTICIPANT","MANDATORY_PARTICIPANT_GONE","EXTERNAL_CHANNEL_CLOSED","SOLVED_BY_BOT","OTHER"] Closing reason of a conversation |
{- "$_type": "EqualsConversationEndReasonOperator",
- "type": "EQUALS",
- "value": "ENDED_BY_PARTICIPANT"
}
$_type | string Default: "ConversationEndedEvent" Value: "ConversationEndedEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
object (ConversationData) Metadata information about a conversation |
{- "$_type": "ConversationEndedEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "conversation": {
- "$_type": "ConversationData",
- "creationTimestamp": 0,
- "endTimestamp": 0,
- "id": "string",
- "accountId": "string",
- "topic": "string",
- "recipient": {
- "$_type": "AccountData",
- "id": "string",
- "displayName": "string",
- "avatar": "string"
}, - "participants": [
- {
- "$_type": "ParticipantData",
- "state": "CREATED",
- "personId": "string",
- "connectedViaExternalMessenger": true,
- "hidden": true,
- "conversationStarred": true
}
], - "assigneePersonId": "string",
- "contextPersonId": "string",
- "state": "CREATED",
- "initialEngagementType": "CHAT_REQUEST",
- "locale": "string",
- "tokboxSessionId": "string",
- "visitorData": "string",
- "conversationTemplateId": "string",
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
], - "externalMessengerChannelId": "string",
- "sourceId": "string",
- "endReason": "ENDED_BY_PARTICIPANT",
- "initialEngagementUrl": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
}
$_type | string Default: "ConversationFileData" Value: "ConversationFileData" |
conversationId | string The id of the Conversation, in which the file was shared/sent |
ownerPersonId | string The id of the owner Person, who shared/sent this file in the conversation |
name | string The name of the file, which was shared/sent in the conversation |
mimeType | string The mime type of the file, which was shared/sent in the conversation |
source | string The source of the file, which was shared/sent in the conversation (is either the name of the uploading person or the uploading system) |
fileStoreId | string The file store id of the actual content of the file, which was shared/sent in the conversation. Stored at the collaboration server. |
totalSize | integer <int64> The total size in bytes of the file, which was shared/sent in the conversation. Note that it is not always set. |
downloadLink | string The url link to download the file. Note that the access must be done from an authenticated user with admin rights. This may either be done using basic authentication or a valid session cookie. |
creationTimestamp | integer <int64> Creation timestamp, when the file was shared/sent in the conversation |
{- "$_type": "ConversationFileData",
- "conversationId": "string",
- "ownerPersonId": "string",
- "name": "string",
- "mimeType": "string",
- "source": "string",
- "fileStoreId": "string",
- "totalSize": 0,
- "downloadLink": "string",
- "creationTimestamp": 0
}
$_type | string Default: "ConversationHistoryData" Value: "ConversationHistoryData" |
id | string Id of the conversation |
any (ConversationRecipientData) Recipient of a conversation: Either a single | |
object (PersonData) Representation of a Person (Agent or Visitor). | |
object (PersonData) Representation of a Person (Agent or Visitor). | |
object (PersonData) Representation of a Person (Agent or Visitor). | |
Array of objects (ParticipantHistoryData) [ items ] All participants (present and past) of the conversation | |
createdTimestamp | integer <int64> utc timestamp when the conversation was created (timestamp when the state was set to |
onboardingTimestamp | integer <int64> utc timestamp when the onboarding of the conversation started (timestamp when the state was set to |
activationTimestamp | integer <int64> utc timestamp when the conversation was activated (timestamp when the state was set to |
assigneeJoinTimestamp | integer <int64> utc timestamp when the assignee joined the conversation (timestamp when the state of the first agent participant was set to |
reboardingTimestamp | integer <int64> utc timestamp when the reboarding of the conversation last started, i.e. when the conversation state was last set to |
offboardingTimestamp | integer <int64> utc timestamp when the offboarding of the conversation started (timestamp when the state was set to |
endTimestamp | integer <int64> utc timestamp when the conversation has ended (all active participants have finished their offboarding; timestamp when the state was set to |
queuedTimestamp | integer <int64> utc timestamp when the conversation was last queued. Null if the conversation was never be queued. |
state | string (EConversationState) Enum: "CREATED" "ONBOARDING" "REBOARDING" "QUEUED" "ACTIVE" "UNASSIGNED" "OFFBOARDING" "ENDED" enum-descriptions: ["CREATED: Initial state of a conversation","ONBOARDING: Depending of the engagement type of the conversation, the conversation stays in the onboarding state as long as the person in the center of the conversation is doing his onboarding","REBOARDING: When a message is send to an unassigned conversation, the conversation first is put into the reboarding state as long as the person in the center of the conversation is doing the reboarding.","QUEUED: Depending of the engagement type of the conversation, the conversation is put in the queued state when it is inside the queue.","ACTIVE: Conversation is active","UNASSIGNED: After there is no assignee of a conversation anymore, the conversation goes to unassigned state until a message from a visitor is written to start reboarding again.","OFFBOARDING: Conversation is being ended","ENDED: Conversation is ended"] Life cycle state of the conversation. Following transitions are possible:
|
initialEngagementType | string (EInitialEngagementType) Enum: "CHAT_REQUEST" "OFFLINE_CHAT_REQUEST" "VIDEO_REQUEST" "AUDIO_REQUEST" "HEADLESS_BROWSER_REQUEST" "DOMCAP_BROWSER_REQUEST" "MOBILE_COBROWSING_REQUEST" "SCREEN_SHARING_REQUEST" "VISITOR_COBROWSING" "HEADLESS_PIN" "DOMCAP_PIN" "MOBILE_PIN" "SCREEN_SHARING_PIN" "CHAT_INVITE" "HEADLESS_INVITE" "SCREEN_SHARING_INVITE" enum-descriptions: ["CHAT_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming chat conversation.","OFFLINE_CHAT_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming chat conversation while all agents are offline.","VIDEO_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming video conversation.","AUDIO_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming audio conversation.","HEADLESS_BROWSER_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming universal co-browsing conversation.","DOMCAP_BROWSER_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming embedded co-browsing conversation.","MOBILE_COBROWSING_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming mobile co-browsing conversation.","SCREEN_SHARING_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming screen sharing conversation.","VISITOR_COBROWSING: (Api initiated, visitor centered) A visitor creates a conversation via API which is not added to the queue and where he can invite other visitor to do embedded","HEADLESS_PIN: (Agent initiated, visitor centered) An agent creates a conversation with a PIN invitation for the visitor to join an universal co-browsing conversation.","DOMCAP_PIN: (Agent initiated, visitor centered) An agent creates a conversation with a PIN invitation for the visitor to join an embedded co-browsing conversation.","MOBILE_PIN: (Agent initiated, visitor centered) An agent creates a conversation with a PIN invitation for the visitor to join a mobile co-browsing conversation.","SCREEN_SHARING_PIN: (Agent initiated, visitor centered) An agent creates a conversation with a PIN invitation for the visitor to join a screen sharing conversation.","CHAT_INVITE: (Agent initiated, agent centered) An agent creates a chat conversation (this is the recommended initial engagement type for conversation created with the Web API).","HEADLESS_INVITE: (Agent initiated, agent centered) An agent creates universal co-browsing conversation and invites customer later.","SCREEN_SHARING_INVITE: (Agent initiated, agent centered) An agent creates screen sharing conversation and invites customer later."] The initial type of a conversation. The type used at creation time of the conversation determines the conversation template that is used. |
locale | string Locale of the conversation language (as BCP 47 language tag form including region if available) |
endReason | string (EConversationEndReason) Enum: "ENDED_BY_PARTICIPANT" "MANDATORY_PARTICIPANT_GONE" "EXTERNAL_CHANNEL_CLOSED" "SOLVED_BY_BOT" "OTHER" enum-descriptions: ["ENDED_BY_PARTICIPANT","MANDATORY_PARTICIPANT_GONE","EXTERNAL_CHANNEL_CLOSED","SOLVED_BY_BOT","OTHER"] Closing reason of a conversation |
tokboxSessionId | string Tokbox sessionId. |
conversationTemplateId | string Template id of this conversation. If omitted, the default conversationTemplate will be retrieved based on the initialEngagementType |
externalMessengerChannelIconId | string External messenger channel id. |
externalMessengerChannelName | string External messenger name. |
{- "$_type": "ConversationHistoryData",
- "id": "string",
- "recipient": {
- "$_type": "AccountData",
- "id": "string",
- "displayName": "string",
- "avatar": "string"
}, - "assigneePerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "contextPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "endPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "participants": [
- {
- "$_type": "ParticipantHistoryData",
- "state": "CREATED",
- "createdTimestamp": 0,
- "joinedTimestamp": 0,
- "activationTimestamp": 0,
- "offboardingTimestamp": 0,
- "leftTimestamp": 0,
- "conversationRating": 0,
- "isHidden": true,
- "conversationStarred": true,
- "person": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}
}
], - "createdTimestamp": 0,
- "onboardingTimestamp": 0,
- "activationTimestamp": 0,
- "assigneeJoinTimestamp": 0,
- "reboardingTimestamp": 0,
- "offboardingTimestamp": 0,
- "endTimestamp": 0,
- "queuedTimestamp": 0,
- "state": "CREATED",
- "initialEngagementType": "CHAT_REQUEST",
- "locale": "string",
- "endReason": "ENDED_BY_PARTICIPANT",
- "tokboxSessionId": "string",
- "conversationTemplateId": "string",
- "externalMessengerChannelIconId": "string",
- "externalMessengerChannelName": "string"
}
$_type | string Default: "ConversationHistoryMessageData" Value: "ConversationHistoryMessageData" |
id | string ID of the message. |
conversationId | string ID of the conversation to which this message belongs. |
sendTimestamp | integer <int64> UTC time stamp when the message was sent from the client. |
serverTimestamp | integer <int64> UTC time stamp when the message was received on the Unblu server. |
senderPersonId | string ID of the person that send the message. May be null for system messages. |
type | string (EMessageType) Enum: "TEXT" "FILE" "CARD" "LIST" "APPROVAL_REQUEST" "MULTICHOICE_QUESTION" "RATING_QUESTION" "TEXT_QUESTION" "REPLY" "QUESTION_ABORTED" enum-descriptions: ["TEXT","FILE","CARD","LIST","APPROVAL_REQUEST","MULTICHOICE_QUESTION","RATING_QUESTION","TEXT_QUESTION","REPLY","QUESTION_ABORTED"] The message type of a conversation message |
recipientPersonIds | Array of strings IDs of persons that the message was addressed to. If it is null, all active participations are regarded as recipients. |
text | string Text representation of the message. |
{- "$_type": "ConversationHistoryMessageData",
- "id": "string",
- "conversationId": "string",
- "sendTimestamp": 0,
- "serverTimestamp": 0,
- "senderPersonId": "string",
- "type": "TEXT",
- "recipientPersonIds": [
- "string"
], - "text": "string"
}
$_type | string Default: "ConversationIdConversationInvitationSearchFilter" Value: "ConversationIdConversationInvitationSearchFilter" |
field | string (EConversationInvitationSearchFilterField) Enum: "INVITATION_TYPE" "TARGET_TYPE" "CONVERSATION_ID" "TARGET_ID" "EXPIRATION_TIMESTAMP" "CREATION_TIMESTAMP" "CREATOR_TYPE" "CREATOR_PERSON_ID" "REDEEMING_PERSON_ID" enum-descriptions: ["INVITATION_TYPE: Filter by the 'type' attribute","TARGET_TYPE: Filter by the 'targetType' attribute","CONVERSATION_ID: Filter by the 'conversationId' attribute","TARGET_ID: Filter by the 'targetId' attribute","EXPIRATION_TIMESTAMP: Filter by the 'expirationTimestamp' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","CREATOR_TYPE: Filter by the 'creatorType' attribute","CREATOR_PERSON_ID: Filter by the 'creatorId' attribute","REDEEMING_PERSON_ID: Filter by the 'redeemerPersonId' attribute"] |
any (IdOperator) Defines operators used for comparing id fields in tables. |
{- "$_type": "ConversationIdConversationInvitationSearchFilter",
- "field": "INVITATION_TYPE",
- "operator": {
- "$_type": "EqualsIdOperator",
- "type": "EQUALS",
- "value": "string"
}
}
$_type | string Default: "ConversationInvitationData" Value: "ConversationInvitationData" |
accountId | string The account ID the invitation originated from. |
invitationType | string (EInvitationType) Enum: "CONVERSATION_REQUEST" "AGENT_FORWARDING" "AGENT_INVITATION" "VISITOR_INVITATION" "PIN_CONVERSATION" enum-descriptions: ["CONVERSATION_REQUEST: All visitor conversation requests e.g. Voice / Video-Call, Co-Browsing Request, etc.","AGENT_FORWARDING: Conversation forwarding to an other agent, directly or via a team. <ul> <li>The forwarding agent will leave the conversation once it has been accepted.</li> <li>The assignee will change to the forwarded agent once it has been accepted.</li> </ul>","AGENT_INVITATION: Invites an other agent into the conversation, directly or via a team. <ul> <li>The inviting agent stays in the conversation.</li> <li>The assignee will NOT change when the invited agent accepts the invitation.</li> </ul>","VISITOR_INVITATION: Anonymous Visitor invitation <ul> <li>Anyone with the invitations ticket (and the accounts API key) may enter the conversation as a Visitor.</li> <li>Once the invitation has been redeemed it can not be reused by other Visitors.</li> </ul>","PIN_CONVERSATION: Universal / Embedded / Mobile PIN Session. <ul> <li>The conversation doesn't really start until the invitation is redeemed.</li> <li>Anyone with the invitations ticket (and the accounts API key) may enter the conversation as a Visitor.</li> <li>Once the ticket has been redeemed it can not be reused by other Visitors.</li> </ul>"] |
invitationState | string (EInvitationState) Enum: "OPEN" "REDEEMED" "REVOKED" "EXPIRED" enum-descriptions: ["OPEN","REDEEMED","REVOKED","EXPIRED"] Reuses names of values from |
id | string Id of the invitation |
conversationId | string Id of the conversation that this invitation is for |
token | string Token (digits for pin or character sequence) required to redeem or revoke the invitation |
createdTimestamp | integer <int64> Unix timestamp of when the invitation was created |
creatorType | string (EInvitationCreatorType) Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR" enum-descriptions: ["WEB_API: Invitation created with the API","SYSTEM: Invitation created by the system","AGENT: Invitation created by an agent","VISITOR: Invitation created by a visitor"] The type of the person/system who created an invitation |
creatorPersonId | string If the creator is an agent or visitor, then this contains the ID of the corresponding person. |
targetId | string ID of the recipient that is expected to redeem this invitation |
targetType | string (EInvitationTargetType) Enum: "ANONYMOUS" "VISITOR" "AGENT" "TEAM" "NAMED_AREA" "ACCOUNT" enum-descriptions: ["ANONYMOUS","VISITOR","AGENT","TEAM","NAMED_AREA","ACCOUNT"] |
Array of objects (ConversationLink) [ items ] List of links that can be used to accept this invitation and open the corresponding conversation. | |
redeemingPersonId | string ID of the person that redeemed this invitation. (Not present as long as the invitation is not redeemed) |
comment | string Text provided by the creator of the invitation which will be displayed to the target of the invitation. |
string Email address that will be used if an anonymous visitor redeems this invitation (only possible for Invitations of type VISITOR_INVITATION and PIN_CONVERSATION). The email address will be stored on the corresponding visitor's person. | |
nickname | string Nickname that will be used if an anonymous visitor redeems this invitation (only possible for Invitations of type VISITOR_INVITATION and PIN_CONVERSATION). The nickname will be stored on the corresponding visitor's person. |
expirationTimestamp | integer <int64> Unix timestamp after witch the invitation is no longer valid |
{- "$_type": "ConversationInvitationData",
- "accountId": "string",
- "invitationType": "CONVERSATION_REQUEST",
- "invitationState": "OPEN",
- "id": "string",
- "conversationId": "string",
- "token": "string",
- "createdTimestamp": 0,
- "creatorType": "WEB_API",
- "creatorPersonId": "string",
- "targetId": "string",
- "targetType": "ANONYMOUS",
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
], - "redeemingPersonId": "string",
- "comment": "string",
- "email": "string",
- "nickname": "string",
- "expirationTimestamp": 0
}
$_type | string Default: "ConversationInvitationOrderBy" Value: "ConversationInvitationOrderBy" |
field | string (EConversationInvitationOrderByField) Enum: "TYPE" "TARGET_TYPE" "CONVERSATION_ID" "TARGET_ID" "EXPIRATION_TIMESTAMP" "CREATION_TIMESTAMP" "CREATOR_TYPE" "CREATOR_ID" "REDEEMER_PERSON_ID" "SUBTYPE" enum-descriptions: ["TYPE: Sort by the 'type' attribute","TARGET_TYPE: Sort by the 'targetType' attribute","CONVERSATION_ID: Sort by the 'conversationId' attribute","TARGET_ID: Sort by the 'targetId' attribute","EXPIRATION_TIMESTAMP: Sort by the 'expirationTimestamp' attribute","CREATION_TIMESTAMP: Sort by the 'creationTimestamp' attribute","CREATOR_TYPE: Sort by the 'creatorType' attribute","CREATOR_ID: Sort by the 'creatorId' attribute","REDEEMER_PERSON_ID: Sort by the 'redeemerPersonId' attribute","SUBTYPE: Sort by the 'subtype' attribute"] |
order | string (Order) Enum: "ASCENDING" "DESCENDING" enum-descriptions: ["ASCENDING: Sort in the ascending order (smallest to largest, 0 to 9, and/or A to Z)","DESCENDING: Sort in the descending order (largest to smallest, 9 to 0, and/or Z to A)"] |
{- "$_type": "ConversationInvitationOrderBy",
- "field": "TYPE",
- "order": "ASCENDING"
}
$_type | string Default: "ConversationInvitationQuery" Value: "ConversationInvitationQuery" |
Array of any (ConversationInvitationSearchFilter) [ items ] List of filters to narrow the search of entities | |
Array of objects (ConversationInvitationOrderBy) [ items ] List of criteria to order the search result list | |
offset | integer <int32> Offset position in the result set to start pagination |
limit | integer <int32> Maximal amount of items returned |
{- "$_type": "ConversationInvitationQuery",
- "searchFilters": [
- {
- "$_type": "TargetTypeConversationInvitationSearchFilter",
- "field": "INVITATION_TYPE",
- "operator": {
- "$_type": "EqualsInvitationTargetTypeOperator",
- "type": "EQUALS",
- "value": "ANONYMOUS"
}
}
], - "orderBy": [
- {
- "$_type": "ConversationInvitationOrderBy",
- "field": "TYPE",
- "order": "ASCENDING"
}
], - "offset": 0,
- "limit": 0
}
$_type | string Default: "ConversationInvitationResult" Value: "ConversationInvitationResult" |
hasMoreItems | boolean Flag to indicate if there are more items on the server |
nextOffset | integer <int32> If more items are present on the server, this value can be used as offset in the next query |
Array of objects (ConversationInvitationData) [ items ] The returned list of entities |
{- "$_type": "ConversationInvitationResult",
- "hasMoreItems": true,
- "nextOffset": 0,
- "items": [
- {
- "$_type": "ConversationInvitationData",
- "accountId": "string",
- "invitationType": "CONVERSATION_REQUEST",
- "invitationState": "OPEN",
- "id": "string",
- "conversationId": "string",
- "token": "string",
- "createdTimestamp": 0,
- "creatorType": "WEB_API",
- "creatorPersonId": "string",
- "targetId": "string",
- "targetType": "ANONYMOUS",
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
], - "redeemingPersonId": "string",
- "comment": "string",
- "email": "string",
- "nickname": "string",
- "expirationTimestamp": 0
}
]
}
$_type | string Default: "ConversationIdConversationInvitationSearchFilter" Value: "ConversationIdConversationInvitationSearchFilter" |
field | string (EConversationInvitationSearchFilterField) enum-descriptions: ["INVITATION_TYPE: Filter by the 'type' attribute","TARGET_TYPE: Filter by the 'targetType' attribute","CONVERSATION_ID: Filter by the 'conversationId' attribute","TARGET_ID: Filter by the 'targetId' attribute","EXPIRATION_TIMESTAMP: Filter by the 'expirationTimestamp' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","CREATOR_TYPE: Filter by the 'creatorType' attribute","CREATOR_PERSON_ID: Filter by the 'creatorId' attribute","REDEEMING_PERSON_ID: Filter by the 'redeemerPersonId' attribute"] CONVERSATION_ID INVITATION_TYPE TARGET_TYPE CONVERSATION_ID TARGET_ID EXPIRATION_TIMESTAMP CREATION_TIMESTAMP CREATOR_TYPE CREATOR_PERSON_ID REDEEMING_PERSON_ID |
any (IdOperator) Defines operators used for comparing id fields in tables. |
{- "$_type": "ConversationIdConversationInvitationSearchFilter",
- "field": "CONVERSATION_ID",
- "operator": {
- "$_type": "EqualsIdOperator",
- "type": "EQUALS",
- "value": "string"
}
}
$_type | string Default: "ConversationLink" Value: "ConversationLink" |
type | string (EConversationLinkType) Enum: "ACCEPT_IN_AGENT_DESK" "ACCEPT_IN_AGENT_SINGLE_VIEW" "ACCEPT_IN_VISITOR_DESK" "OPEN_IN_AGENT_DESK" "OPEN_IN_AGENT_SINGLE_VIEW" "OPEN_IN_VISITOR_DESK" enum-descriptions: ["ACCEPT_IN_AGENT_DESK: Link that accepts the invitation and loads the agent desk to display the conversation","ACCEPT_IN_AGENT_SINGLE_VIEW: Link that accepts the invitation and display the conversation in a single view <p> The single view only displays the conversation without any navigation and other agent desk features and can be used for integration into third party applications.","ACCEPT_IN_VISITOR_DESK: Link that accepts the invitation and display the conversation in a visitor desk","OPEN_IN_AGENT_DESK: Link to open an existing conversation in the agent desk to display the conversation","OPEN_IN_AGENT_SINGLE_VIEW: Link to open an existing conversation in a single view <p> The single view only displays the conversation without any navigation and other agent desk features and can be used for integration into third party applications.","OPEN_IN_VISITOR_DESK: Link to open an existing conversation in a visitor desk"] Type of link used to accept an invitation. |
url | string Url of the link |
{- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
$_type | string Default: "ConversationMessageStateEvent" Value: "ConversationMessageStateEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
messageId | string The id of the message which state has changed |
state | string (EMessageState) Enum: "DELIVERED" "READ" enum-descriptions: ["DELIVERED: The message was delivered to the recipients","READ: The message was read by the recipients"] The state of a message if it was delivered or read |
conversationId | string The conversation to which the message belongs to |
{- "$_type": "ConversationMessageStateEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "messageId": "string",
- "state": "DELIVERED",
- "conversationId": "string"
}
$_type | string Default: "ConversationNewMessageEvent" Value: "ConversationNewMessageEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
any (MessageData) Base class for all conversation messages. Can be one of |
{- "$_type": "ConversationNewMessageEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "conversationMessage": {
- "$_type": "ApprovalRequestMessageData",
- "id": "string",
- "conversationId": "string",
- "externalMessengerChannelId": "string",
- "accountId": "string",
- "senderPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "senderPersonPresenceId": "string",
- "serverTimestamp": 0,
- "sendTimestamp": 0,
- "type": "TEXT",
- "recipientPersonIds": [
- "string"
], - "fallbackText": "string",
- "actionId": "string",
- "sourceId": "string",
- "text": "string",
- "textType": "SIMPLE_TEXT",
- "options": [
- {
- "$_type": "MultichoiceQuestionOption",
- "label": "string",
- "value": "string",
- "primary": true
}
], - "answerStatus": "PENDING"
}
}
$_type | string Default: "ConversationOrderBy" Value: "ConversationOrderBy" |
field | string (EConversationOrderByField) Enum: "CREATION_TIMESTAMP" "END_TIMESTAMP" "ID" "TOPIC" "ASSIGNEE_PERSON_ID" "CONTEXT_PERSON_ID" "STATE" "INITIAL_ENGAGEMENT_TYPE" "LOCALE" "TOKBOX_SESSION_ID" "CONVERSATION_TEMPLATE_ID" "EXTERNAL_MESSENGER_CHANNEL_ID" "SOURCE_ID" "END_REASON" "RECIPIENT_ID" "RECIPIENT_TYPE" enum-descriptions: ["CREATION_TIMESTAMP: Sort by the 'creationTimestamp' attribute","END_TIMESTAMP: Sort by the 'endTimestamp' attribute","ID: Sort by the 'id' attribute","TOPIC: Sort by the 'topic' attribute","ASSIGNEE_PERSON_ID: Sort by the 'assigneePersonId' attribute","CONTEXT_PERSON_ID: Sort by the 'contextPersonId' attribute","STATE: Sort by the 'state' attribute","INITIAL_ENGAGEMENT_TYPE: Sort by the 'initialEngagementType' attribute","LOCALE: Sort by the 'locale' attribute","TOKBOX_SESSION_ID: Sort by the 'tokboxSessionId' attribute","CONVERSATION_TEMPLATE_ID: Sort by the 'conversationTemplateId' attribute","EXTERNAL_MESSENGER_CHANNEL_ID: Sort by the 'externalMessengerChannelId' attribute","SOURCE_ID: Sort by the 'sourceId' attribute","END_REASON: Sort by the 'endReason' attribute","RECIPIENT_ID: Sort by the 'recipientId' attribute","RECIPIENT_TYPE: Sort by the 'recipientType' attribute"] |
order | string (Order) Enum: "ASCENDING" "DESCENDING" enum-descriptions: ["ASCENDING: Sort in the ascending order (smallest to largest, 0 to 9, and/or A to Z)","DESCENDING: Sort in the descending order (largest to smallest, 9 to 0, and/or Z to A)"] |
{- "$_type": "ConversationOrderBy",
- "field": "CREATION_TIMESTAMP",
- "order": "ASCENDING"
}
$_type | string Default: "ConversationQuery" Value: "ConversationQuery" |
Array of any (ConversationSearchFilter) [ items ] List of filters to narrow the search of entities | |
Array of objects (ConversationOrderBy) [ items ] List of criteria to order the search result list | |
offset | integer <int32> Offset position in the result set to start pagination |
limit | integer <int32> Maximal amount of items returned |
{- "$_type": "ConversationQuery",
- "searchFilters": [
- {
- "$_type": "ParticipantPersonIdConversationSearchFilter",
- "field": "CREATION_TIMESTAMP",
- "operator": {
- "$_type": "AllOfIdListOperator",
- "type": "ALL_OF",
- "values": [
- "string"
]
}
}
], - "orderBy": [
- {
- "$_type": "ConversationOrderBy",
- "field": "CREATION_TIMESTAMP",
- "order": "ASCENDING"
}
], - "offset": 0,
- "limit": 0
}
$_type | string Default: "AccountData" AccountData TeamData PersonData NamedAreaData AccountData |
id | string Unique id of the account. |
displayName | string Display-Name of the account |
string or Avatar (object) expand-query-key: avatar type: ExpandableField Avatar of the account: id that can be expanded. |
{- "$_type": "AccountData",
- "id": "string",
- "displayName": "string",
- "avatar": "string"
}
$_type | string Default: "EqualsConversationRecipientTypeOperator" Value: "EqualsConversationRecipientTypeOperator" |
type | string (EConversationRecipientTypeOperatorType) enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator"] EQUALS EQUALS NOT_EQUALS IN NOT_IN |
value | string (EConversationRecipientType) Enum: "AGENT" "TEAM" "NAMED_AREA" "ACCOUNT" enum-descriptions: ["AGENT: Recipient is a single agent","TEAM: Recipient is an agent of the team","NAMED_AREA: Recipient is an agent responsible for a specific named-area","ACCOUNT: Recipient is one of all the agents of an account"] Recipient type of the conversation |
{- "$_type": "EqualsConversationRecipientTypeOperator",
- "type": "EQUALS",
- "value": "AGENT"
}
$_type | string Default: "ConversationResult" Value: "ConversationResult" |
hasMoreItems | boolean Flag to indicate if there are more items on the server |
nextOffset | integer <int32> If more items are present on the server, this value can be used as offset in the next query |
Array of objects (ConversationData) [ items ] The returned list of entities |
{- "$_type": "ConversationResult",
- "hasMoreItems": true,
- "nextOffset": 0,
- "items": [
- {
- "$_type": "ConversationData",
- "creationTimestamp": 0,
- "endTimestamp": 0,
- "id": "string",
- "accountId": "string",
- "topic": "string",
- "recipient": {
- "$_type": "AccountData",
- "id": "string",
- "displayName": "string",
- "avatar": "string"
}, - "participants": [
- {
- "$_type": "ParticipantData",
- "state": "CREATED",
- "personId": "string",
- "connectedViaExternalMessenger": true,
- "hidden": true,
- "conversationStarred": true
}
], - "assigneePersonId": "string",
- "contextPersonId": "string",
- "state": "CREATED",
- "initialEngagementType": "CHAT_REQUEST",
- "locale": "string",
- "tokboxSessionId": "string",
- "visitorData": "string",
- "conversationTemplateId": "string",
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
], - "externalMessengerChannelId": "string",
- "sourceId": "string",
- "endReason": "ENDED_BY_PARTICIPANT",
- "initialEngagementUrl": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
]
}
$_type | string Default: "AssigneePersonIdConversationSearchFilter" Value: "AssigneePersonIdConversationSearchFilter" |
field | string (EConversationSearchFilterField) enum-descriptions: ["CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","END_TIMESTAMP: Filter by the 'endTimestamp' attribute","INITIAL_ENGAGEMENT_TYPE: Filter by the 'initialEngagementType' attribute","TOPIC: Filter by the 'topic' attribute","CONTEXT_PERSON_ID: Filter by the 'contextPersonId' attribute","ASSIGNEE_PERSON_ID: Filter by the 'assigneePersonId' attribute","PARTICIPANT_PERSON_ID: Filter by the 'personId' of the participants","STATE: Filter by the 'state' attribute","END_REASON: Filter by the 'endReason' attribute","CONVERSATION_TEMPLATE_ID: Filter by the 'conversationTemplateId' attribute","RECIPIENT_ID: Filter by the 'id' of the 'recipient' attribute","RECIPIENT_TYPE: Filter by the 'type' of the 'recipient' attribute","TOKBOX_SESSION_ID: Filter by the 'tokboxSessionId' attribute"] ASSIGNEE_PERSON_ID CREATION_TIMESTAMP END_TIMESTAMP INITIAL_ENGAGEMENT_TYPE TOPIC CONTEXT_PERSON_ID ASSIGNEE_PERSON_ID PARTICIPANT_PERSON_ID STATE END_REASON CONVERSATION_TEMPLATE_ID RECIPIENT_ID RECIPIENT_TYPE TOKBOX_SESSION_ID |
any (IdOperator) Defines operators used for comparing id fields in tables. |
{- "$_type": "AssigneePersonIdConversationSearchFilter",
- "field": "ASSIGNEE_PERSON_ID",
- "operator": {
- "$_type": "EqualsIdOperator",
- "type": "EQUALS",
- "value": "string"
}
}
$_type | string Default: "EqualsConversationStateOperator" Value: "EqualsConversationStateOperator" |
type | string (EConversationStateOperatorType) enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator"] EQUALS EQUALS NOT_EQUALS IN NOT_IN |
value | string (EConversationState) Enum: "CREATED" "ONBOARDING" "REBOARDING" "QUEUED" "ACTIVE" "UNASSIGNED" "OFFBOARDING" "ENDED" enum-descriptions: ["CREATED: Initial state of a conversation","ONBOARDING: Depending of the engagement type of the conversation, the conversation stays in the onboarding state as long as the person in the center of the conversation is doing his onboarding","REBOARDING: When a message is send to an unassigned conversation, the conversation first is put into the reboarding state as long as the person in the center of the conversation is doing the reboarding.","QUEUED: Depending of the engagement type of the conversation, the conversation is put in the queued state when it is inside the queue.","ACTIVE: Conversation is active","UNASSIGNED: After there is no assignee of a conversation anymore, the conversation goes to unassigned state until a message from a visitor is written to start reboarding again.","OFFBOARDING: Conversation is being ended","ENDED: Conversation is ended"] Life cycle state of the conversation. Following transitions are possible:
|
{- "$_type": "EqualsConversationStateOperator",
- "type": "EQUALS",
- "value": "CREATED"
}
$_type | string Default: "ConversationTemplate" Value: "ConversationTemplate" |
id | string Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway. |
creationTimestamp | integer <int64> Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
modificationTimestamp | integer <int64> Timestamp of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
version | integer <int64> Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted. |
accountId | string Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
name | string Name of the named area. Maximum of 250 characters. Can not be omitted. |
description | string Description of the named area. Maximum of 500 characters. Can be omitted. |
defaultTemplate | boolean If true, this will be the default template for the initial engagement Type |
initialEngagementType | string (EInitialEngagementType) Enum: "CHAT_REQUEST" "OFFLINE_CHAT_REQUEST" "VIDEO_REQUEST" "AUDIO_REQUEST" "HEADLESS_BROWSER_REQUEST" "DOMCAP_BROWSER_REQUEST" "MOBILE_COBROWSING_REQUEST" "SCREEN_SHARING_REQUEST" "VISITOR_COBROWSING" "HEADLESS_PIN" "DOMCAP_PIN" "MOBILE_PIN" "SCREEN_SHARING_PIN" "CHAT_INVITE" "HEADLESS_INVITE" "SCREEN_SHARING_INVITE" enum-descriptions: ["CHAT_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming chat conversation.","OFFLINE_CHAT_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming chat conversation while all agents are offline.","VIDEO_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming video conversation.","AUDIO_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming audio conversation.","HEADLESS_BROWSER_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming universal co-browsing conversation.","DOMCAP_BROWSER_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming embedded co-browsing conversation.","MOBILE_COBROWSING_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming mobile co-browsing conversation.","SCREEN_SHARING_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming screen sharing conversation.","VISITOR_COBROWSING: (Api initiated, visitor centered) A visitor creates a conversation via API which is not added to the queue and where he can invite other visitor to do embedded","HEADLESS_PIN: (Agent initiated, visitor centered) An agent creates a conversation with a PIN invitation for the visitor to join an universal co-browsing conversation.","DOMCAP_PIN: (Agent initiated, visitor centered) An agent creates a conversation with a PIN invitation for the visitor to join an embedded co-browsing conversation.","MOBILE_PIN: (Agent initiated, visitor centered) An agent creates a conversation with a PIN invitation for the visitor to join a mobile co-browsing conversation.","SCREEN_SHARING_PIN: (Agent initiated, visitor centered) An agent creates a conversation with a PIN invitation for the visitor to join a screen sharing conversation.","CHAT_INVITE: (Agent initiated, agent centered) An agent creates a chat conversation (this is the recommended initial engagement type for conversation created with the Web API).","HEADLESS_INVITE: (Agent initiated, agent centered) An agent creates universal co-browsing conversation and invites customer later.","SCREEN_SHARING_INVITE: (Agent initiated, agent centered) An agent creates screen sharing conversation and invites customer later."] The initial type of a conversation. The type used at creation time of the conversation determines the conversation template that is used. |
object expand-query-key: configuration type: Map The entity's configuration properties. Only contains values when the 'expand' query parameter is used with the value 'configuration'. | |
object expand-query-key: text type: Map The entity's text properties. Only contains values when the 'expand' query parameter is used with the value 'text'. | |
object expand-query-key: metadata type: Map The entity's metadata properties. Only contains values when the 'expand' query parameter is used with the value 'metadata'. |
{- "$_type": "ConversationTemplate",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "name": "string",
- "description": "string",
- "defaultTemplate": true,
- "initialEngagementType": "CHAT_REQUEST",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
$_type | string Default: "ConversationTemplateIdConversationSearchFilter" Value: "ConversationTemplateIdConversationSearchFilter" |
field | string (EConversationSearchFilterField) Enum: "CREATION_TIMESTAMP" "END_TIMESTAMP" "INITIAL_ENGAGEMENT_TYPE" "TOPIC" "CONTEXT_PERSON_ID" "ASSIGNEE_PERSON_ID" "PARTICIPANT_PERSON_ID" "STATE" "END_REASON" "CONVERSATION_TEMPLATE_ID" "RECIPIENT_ID" "RECIPIENT_TYPE" "TOKBOX_SESSION_ID" enum-descriptions: ["CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","END_TIMESTAMP: Filter by the 'endTimestamp' attribute","INITIAL_ENGAGEMENT_TYPE: Filter by the 'initialEngagementType' attribute","TOPIC: Filter by the 'topic' attribute","CONTEXT_PERSON_ID: Filter by the 'contextPersonId' attribute","ASSIGNEE_PERSON_ID: Filter by the 'assigneePersonId' attribute","PARTICIPANT_PERSON_ID: Filter by the 'personId' of the participants","STATE: Filter by the 'state' attribute","END_REASON: Filter by the 'endReason' attribute","CONVERSATION_TEMPLATE_ID: Filter by the 'conversationTemplateId' attribute","RECIPIENT_ID: Filter by the 'id' of the 'recipient' attribute","RECIPIENT_TYPE: Filter by the 'type' of the 'recipient' attribute","TOKBOX_SESSION_ID: Filter by the 'tokboxSessionId' attribute"] |
any (IdOperator) Defines operators used for comparing id fields in tables. |
{- "$_type": "ConversationTemplateIdConversationSearchFilter",
- "field": "CREATION_TIMESTAMP",
- "operator": {
- "$_type": "EqualsIdOperator",
- "type": "EQUALS",
- "value": "string"
}
}
$_type | string Default: "ConversationTemplateOrderBy" Value: "ConversationTemplateOrderBy" |
field | string (EConversationTemplateOrderByField) Enum: "ID" "NAME" "DESCRIPTION" "DEFAULT_TEMPLATE" "INITIAL_ENGAGEMENT_TYPE" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["ID: Sort by the 'id' attribute","NAME: Sort by the 'name' attribute","DESCRIPTION: Sort by the 'description' attribute","DEFAULT_TEMPLATE: Sort by the 'defaultTemplate' attribute","INITIAL_ENGAGEMENT_TYPE: Sort by the 'initialEngagementType' attribute","CREATION_TIMESTAMP: Sort by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Sort by the 'modificationTimestamp' attribute"] |
order | string (Order) Enum: "ASCENDING" "DESCENDING" enum-descriptions: ["ASCENDING: Sort in the ascending order (smallest to largest, 0 to 9, and/or A to Z)","DESCENDING: Sort in the descending order (largest to smallest, 9 to 0, and/or Z to A)"] |
{- "$_type": "ConversationTemplateOrderBy",
- "field": "ID",
- "order": "ASCENDING"
}
$_type | string Default: "ConversationTemplateQuery" Value: "ConversationTemplateQuery" |
Array of any (ConversationTemplateSearchFilter) [ items ] List of filters to narrow the search of entities | |
Array of objects (ConversationTemplateOrderBy) [ items ] List of criteria to order the search result list | |
offset | integer <int32> Offset position in the result set to start pagination |
limit | integer <int32> Maximal amount of items returned |
{- "$_type": "ConversationTemplateQuery",
- "searchFilters": [
- {
- "$_type": "CreationTimestampConversationTemplateSearchFilter",
- "field": "NAME",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
], - "orderBy": [
- {
- "$_type": "ConversationTemplateOrderBy",
- "field": "ID",
- "order": "ASCENDING"
}
], - "offset": 0,
- "limit": 0
}
$_type | string Default: "ConversationTemplateResult" Value: "ConversationTemplateResult" |
hasMoreItems | boolean Flag to indicate if there are more items on the server |
nextOffset | integer <int32> If more items are present on the server, this value can be used as offset in the next query |
Array of objects (ConversationTemplate) [ items ] The returned list of entities |
{- "$_type": "ConversationTemplateResult",
- "hasMoreItems": true,
- "nextOffset": 0,
- "items": [
- {
- "$_type": "ConversationTemplate",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "name": "string",
- "description": "string",
- "defaultTemplate": true,
- "initialEngagementType": "CHAT_REQUEST",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
]
}
$_type | string Default: "CreationTimestampConversationTemplateSearchFilter" Value: "CreationTimestampConversationTemplateSearchFilter" |
field | string (EConversationTemplateSearchFilterField) enum-descriptions: ["NAME: Filter by the 'name' attribute","DESCRIPTION: Filter by the 'description' attribute","DEFAULT_TEMPLATE: Filter by the 'defaultTemplate' attribute","INITIAL_ENGAGEMENT_TYPE: Filter by the 'initialEngagementType' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] CREATION_TIMESTAMP NAME DESCRIPTION DEFAULT_TEMPLATE INITIAL_ENGAGEMENT_TYPE CREATION_TIMESTAMP MODIFICATION_TIMESTAMP |
any (TimestampOperator) |
{- "$_type": "CreationTimestampConversationTemplateSearchFilter",
- "field": "CREATION_TIMESTAMP",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
$_type | string Default: "ConversationUpdatedEvent" Value: "ConversationUpdatedEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
object (ConversationData) Metadata information about a conversation |
{- "$_type": "ConversationUpdatedEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "conversation": {
- "$_type": "ConversationData",
- "creationTimestamp": 0,
- "endTimestamp": 0,
- "id": "string",
- "accountId": "string",
- "topic": "string",
- "recipient": {
- "$_type": "AccountData",
- "id": "string",
- "displayName": "string",
- "avatar": "string"
}, - "participants": [
- {
- "$_type": "ParticipantData",
- "state": "CREATED",
- "personId": "string",
- "connectedViaExternalMessenger": true,
- "hidden": true,
- "conversationStarred": true
}
], - "assigneePersonId": "string",
- "contextPersonId": "string",
- "state": "CREATED",
- "initialEngagementType": "CHAT_REQUEST",
- "locale": "string",
- "tokboxSessionId": "string",
- "visitorData": "string",
- "conversationTemplateId": "string",
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
], - "externalMessengerChannelId": "string",
- "sourceId": "string",
- "endReason": "ENDED_BY_PARTICIPANT",
- "initialEngagementUrl": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
}
personId | string Id of the person to add |
connectedViaExternalMessenger | boolean If the participant is sending messages via a messenger channel, this parameter must be set to true. Otherwise false or do not set. |
hidden | boolean If the person should be hidden or not. Note: only secondary agents and bots may be hidden. |
conversationStarred | boolean If this conversation should be marked as starred for the person. If |
{- "personId": "string",
- "connectedViaExternalMessenger": true,
- "hidden": true,
- "conversationStarred": true
}
personId | string |
hidden | boolean |
{- "personId": "string",
- "hidden": true
}
reason | string (EConversationEndReason) Enum: "ENDED_BY_PARTICIPANT" "MANDATORY_PARTICIPANT_GONE" "EXTERNAL_CHANNEL_CLOSED" "SOLVED_BY_BOT" "OTHER" enum-descriptions: ["ENDED_BY_PARTICIPANT","MANDATORY_PARTICIPANT_GONE","EXTERNAL_CHANNEL_CLOSED","SOLVED_BY_BOT","OTHER"] Closing reason of a conversation |
comment | string |
{- "reason": "ENDED_BY_PARTICIPANT",
- "comment": "string"
}
personId | string |
reason | string (EConversationLeftReason) Enum: "FORWARDED" "PARTICIPANT_LEFT" "REMOVED_AFTER_TIMEOUT" "ONBOARDING_DECLINED" "ONBOARDING_IDLE_TIMEOUT" "ONBOARDING_TIMEOUT" "USER_CHANGED" "KICKED" "CONVERSATION_UNASSIGNED" "CONVERSATION_REQUEUED" "OTHER" enum-descriptions: ["FORWARDED","PARTICIPANT_LEFT","REMOVED_AFTER_TIMEOUT","ONBOARDING_DECLINED","ONBOARDING_IDLE_TIMEOUT","ONBOARDING_TIMEOUT","USER_CHANGED","KICKED","CONVERSATION_UNASSIGNED","CONVERSATION_REQUEUED","OTHER"] Participation left reason of a conversation |
comment | string |
{- "personId": "string",
- "reason": "FORWARDED",
- "comment": "string"
}
personId | string the person for whom the starred status will be set |
starred | boolean the starred status to b set |
{- "personId": "string",
- "starred": true
}
$_type | string Default: "ConversationsSetVisitorDataBody" Value: "ConversationsSetVisitorDataBody" |
visitorData | string Custom visitor data in any format. |
{- "$_type": "ConversationsSetVisitorDataBody",
- "visitorData": "string"
}
$_type | string Default: "CreationTimestampAccountSearchFilter" Value: "CreationTimestampAccountSearchFilter" |
field | string (EAccountSearchFilterField) Enum: "NAME" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["NAME: Filter by the 'name' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] |
any (TimestampOperator) |
{- "$_type": "CreationTimestampAccountSearchFilter",
- "field": "NAME",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
$_type | string Default: "CreationTimestampAddressSearchFilter" Value: "CreationTimestampAddressSearchFilter" |
field | string (EAddressSearchFilterField) Enum: "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] |
any (TimestampOperator) |
{- "$_type": "CreationTimestampAddressSearchFilter",
- "field": "CREATION_TIMESTAMP",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
$_type | string Default: "CreationTimestampApiKeySearchFilter" Value: "CreationTimestampApiKeySearchFilter" |
field | string (EApiKeySearchFilterField) Enum: "NAME" "DESCRIPTION" "API_KEY" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["NAME: Filter by the 'name' attribute","DESCRIPTION: Filter by the 'description' attribute","API_KEY: Filter by the 'apiKey' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] |
any (TimestampOperator) |
{- "$_type": "CreationTimestampApiKeySearchFilter",
- "field": "NAME",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
$_type | string Default: "CreationTimestampCannedResponseSearchFilter" Value: "CreationTimestampCannedResponseSearchFilter" |
field | string (ECannedResponseSearchFilterField) Enum: "KEY" "TITLE" "TEXT" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["KEY: Filter by the 'key' attribute","TITLE: Filter by the 'title' attribute","TEXT: Filter by the 'text' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] |
any (TimestampOperator) |
{- "$_type": "CreationTimestampCannedResponseSearchFilter",
- "field": "KEY",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
$_type | string Default: "CreationTimestampContactSearchFilter" Value: "CreationTimestampContactSearchFilter" |
field | string (EContactSearchFilterField) Enum: "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] |
any (TimestampOperator) |
{- "$_type": "CreationTimestampContactSearchFilter",
- "field": "CREATION_TIMESTAMP",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
$_type | string Default: "CreationTimestampConversationInvitationSearchFilter" Value: "CreationTimestampConversationInvitationSearchFilter" |
field | string (EConversationInvitationSearchFilterField) Enum: "INVITATION_TYPE" "TARGET_TYPE" "CONVERSATION_ID" "TARGET_ID" "EXPIRATION_TIMESTAMP" "CREATION_TIMESTAMP" "CREATOR_TYPE" "CREATOR_PERSON_ID" "REDEEMING_PERSON_ID" enum-descriptions: ["INVITATION_TYPE: Filter by the 'type' attribute","TARGET_TYPE: Filter by the 'targetType' attribute","CONVERSATION_ID: Filter by the 'conversationId' attribute","TARGET_ID: Filter by the 'targetId' attribute","EXPIRATION_TIMESTAMP: Filter by the 'expirationTimestamp' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","CREATOR_TYPE: Filter by the 'creatorType' attribute","CREATOR_PERSON_ID: Filter by the 'creatorId' attribute","REDEEMING_PERSON_ID: Filter by the 'redeemerPersonId' attribute"] |
any (TimestampOperator) |
{- "$_type": "CreationTimestampConversationInvitationSearchFilter",
- "field": "INVITATION_TYPE",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
$_type | string Default: "CreationTimestampConversationSearchFilter" Value: "CreationTimestampConversationSearchFilter" |
field | string (EConversationSearchFilterField) Enum: "CREATION_TIMESTAMP" "END_TIMESTAMP" "INITIAL_ENGAGEMENT_TYPE" "TOPIC" "CONTEXT_PERSON_ID" "ASSIGNEE_PERSON_ID" "PARTICIPANT_PERSON_ID" "STATE" "END_REASON" "CONVERSATION_TEMPLATE_ID" "RECIPIENT_ID" "RECIPIENT_TYPE" "TOKBOX_SESSION_ID" enum-descriptions: ["CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","END_TIMESTAMP: Filter by the 'endTimestamp' attribute","INITIAL_ENGAGEMENT_TYPE: Filter by the 'initialEngagementType' attribute","TOPIC: Filter by the 'topic' attribute","CONTEXT_PERSON_ID: Filter by the 'contextPersonId' attribute","ASSIGNEE_PERSON_ID: Filter by the 'assigneePersonId' attribute","PARTICIPANT_PERSON_ID: Filter by the 'personId' of the participants","STATE: Filter by the 'state' attribute","END_REASON: Filter by the 'endReason' attribute","CONVERSATION_TEMPLATE_ID: Filter by the 'conversationTemplateId' attribute","RECIPIENT_ID: Filter by the 'id' of the 'recipient' attribute","RECIPIENT_TYPE: Filter by the 'type' of the 'recipient' attribute","TOKBOX_SESSION_ID: Filter by the 'tokboxSessionId' attribute"] |
any (TimestampOperator) |
{- "$_type": "CreationTimestampConversationSearchFilter",
- "field": "CREATION_TIMESTAMP",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
$_type | string Default: "CreationTimestampConversationTemplateSearchFilter" Value: "CreationTimestampConversationTemplateSearchFilter" |
field | string (EConversationTemplateSearchFilterField) Enum: "NAME" "DESCRIPTION" "DEFAULT_TEMPLATE" "INITIAL_ENGAGEMENT_TYPE" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["NAME: Filter by the 'name' attribute","DESCRIPTION: Filter by the 'description' attribute","DEFAULT_TEMPLATE: Filter by the 'defaultTemplate' attribute","INITIAL_ENGAGEMENT_TYPE: Filter by the 'initialEngagementType' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] |
any (TimestampOperator) |
{- "$_type": "CreationTimestampConversationTemplateSearchFilter",
- "field": "NAME",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
$_type | string Default: "CreationTimestampDialogBotSearchFilter" Value: "CreationTimestampDialogBotSearchFilter" |
field | string (EDialogBotSearchFilterField) Enum: "NAME" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["NAME: Filter by the 'name' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] |
any (TimestampOperator) |
{- "$_type": "CreationTimestampDialogBotSearchFilter",
- "field": "NAME",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
$_type | string Default: "CreationTimestampDomainSearchFilter" Value: "CreationTimestampDomainSearchFilter" |
field | string (EDomainSearchFilterField) Enum: "DOMAIN_NAME" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["DOMAIN_NAME: Filter by the 'domainName' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] |
any (TimestampOperator) |
{- "$_type": "CreationTimestampDomainSearchFilter",
- "field": "DOMAIN_NAME",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
$_type | string Default: "CreationTimestampExternalMessengerChannelSearchFilter" Value: "CreationTimestampExternalMessengerChannelSearchFilter" |
field | string (EExternalMessengerChannelSearchFilterField) Enum: "NAME" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["NAME: Filter by the 'name' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] |
any (TimestampOperator) |
{- "$_type": "CreationTimestampExternalMessengerChannelSearchFilter",
- "field": "NAME",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
$_type | string Default: "CreationTimestampNamedAreaSearchFilter" Value: "CreationTimestampNamedAreaSearchFilter" |
field | string (ENamedAreaSearchFilterField) Enum: "NAME" "DESCRIPTION" "SITE_ID" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["NAME: Filter by the 'name' attribute","DESCRIPTION: Filter by the 'description' attribute","SITE_ID: Filter by the 'siteId' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] |
any (TimestampOperator) |
{- "$_type": "CreationTimestampNamedAreaSearchFilter",
- "field": "NAME",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
$_type | string Default: "CreationTimestampTeamSearchFilter" Value: "CreationTimestampTeamSearchFilter" |
field | string (ETeamSearchFilterField) Enum: "NAME" "DESCRIPTION" "PARENT_ID" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["NAME: Filter by the 'name' attribute","DESCRIPTION: Filter by the 'description' attribute","PARENT_ID: Filter by the 'parentId' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] |
any (TimestampOperator) |
{- "$_type": "CreationTimestampTeamSearchFilter",
- "field": "NAME",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
$_type | string Default: "CreationTimestampUserSearchFilter" Value: "CreationTimestampUserSearchFilter" |
field | string (EUserSearchFilterField) Enum: "FIRST_NAME" "LAST_NAME" "USERNAME" "TEAM_ID" "EMAIL" "AUTHORIZATION_ROLE" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" "VIRTUAL_USER" enum-descriptions: ["FIRST_NAME: Filter by the 'firstName' attribute","LAST_NAME: Filter by the 'lastName' attribute","USERNAME: Filter by the 'username' attribute","TEAM_ID: Filter by the 'teamId' attribute","EMAIL: Filter by the 'email' attribute","AUTHORIZATION_ROLE: Filter by the 'authorizationRole' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute","VIRTUAL_USER: Filter by the 'virtualUser' attribute"] |
any (TimestampOperator) |
{- "$_type": "CreationTimestampUserSearchFilter",
- "field": "FIRST_NAME",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
$_type | string Default: "CreationTimestampWebhookCallLogSearchFilter" Value: "CreationTimestampWebhookCallLogSearchFilter" |
field | string (EWebhookCallLogSearchFilterField) Enum: "EVENT_NAME" "REGISTRATION_ID" "REQUEST_ID" "EXECUTION_TIMESTAMP" "ENDPOINT" "RETRY_NR" "CREATION_TIMESTAMP" "HTTP_RESPONSE_CODE" enum-descriptions: ["EVENT_NAME: Filter by the 'eventName' attribute","REGISTRATION_ID: Filter by the 'registrationId' attribute","REQUEST_ID: Filter by the 'requestId' attribute","EXECUTION_TIMESTAMP: Filter by the 'executionTimestamp' attribute","ENDPOINT: Filter by the 'endpoint' attribute","RETRY_NR: Filter by the 'retryNr' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","HTTP_RESPONSE_CODE: Filter by the 'httpResponseCode' attribute"] |
any (TimestampOperator) |
{- "$_type": "CreationTimestampWebhookCallLogSearchFilter",
- "field": "EVENT_NAME",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
$_type | string Default: "CreationTimestampWebhookRegistrationSearchFilter" Value: "CreationTimestampWebhookRegistrationSearchFilter" |
field | string (EWebhookRegistrationSearchFilterField) Enum: "NAME" "DESCRIPTION" "ENDPOINT" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["NAME: Sort by the 'name' attribute","DESCRIPTION: Sort by the 'description' attribute","ENDPOINT: Sort by the 'endpoint' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] |
any (TimestampOperator) |
{- "$_type": "CreationTimestampWebhookRegistrationSearchFilter",
- "field": "NAME",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
$_type | string Default: "CreatorPersonIdConversationInvitationSearchFilter" Value: "CreatorPersonIdConversationInvitationSearchFilter" |
field | string (EConversationInvitationSearchFilterField) Enum: "INVITATION_TYPE" "TARGET_TYPE" "CONVERSATION_ID" "TARGET_ID" "EXPIRATION_TIMESTAMP" "CREATION_TIMESTAMP" "CREATOR_TYPE" "CREATOR_PERSON_ID" "REDEEMING_PERSON_ID" enum-descriptions: ["INVITATION_TYPE: Filter by the 'type' attribute","TARGET_TYPE: Filter by the 'targetType' attribute","CONVERSATION_ID: Filter by the 'conversationId' attribute","TARGET_ID: Filter by the 'targetId' attribute","EXPIRATION_TIMESTAMP: Filter by the 'expirationTimestamp' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","CREATOR_TYPE: Filter by the 'creatorType' attribute","CREATOR_PERSON_ID: Filter by the 'creatorId' attribute","REDEEMING_PERSON_ID: Filter by the 'redeemerPersonId' attribute"] |
any (IdOperator) Defines operators used for comparing id fields in tables. |
{- "$_type": "CreatorPersonIdConversationInvitationSearchFilter",
- "field": "INVITATION_TYPE",
- "operator": {
- "$_type": "EqualsIdOperator",
- "type": "EQUALS",
- "value": "string"
}
}
$_type | string Default: "CreatorTypeConversationInvitationSearchFilter" Value: "CreatorTypeConversationInvitationSearchFilter" |
field | string (EConversationInvitationSearchFilterField) Enum: "INVITATION_TYPE" "TARGET_TYPE" "CONVERSATION_ID" "TARGET_ID" "EXPIRATION_TIMESTAMP" "CREATION_TIMESTAMP" "CREATOR_TYPE" "CREATOR_PERSON_ID" "REDEEMING_PERSON_ID" enum-descriptions: ["INVITATION_TYPE: Filter by the 'type' attribute","TARGET_TYPE: Filter by the 'targetType' attribute","CONVERSATION_ID: Filter by the 'conversationId' attribute","TARGET_ID: Filter by the 'targetId' attribute","EXPIRATION_TIMESTAMP: Filter by the 'expirationTimestamp' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","CREATOR_TYPE: Filter by the 'creatorType' attribute","CREATOR_PERSON_ID: Filter by the 'creatorId' attribute","REDEEMING_PERSON_ID: Filter by the 'redeemerPersonId' attribute"] |
any (InvitationCreatorTypeOperator) |
{- "$_type": "CreatorTypeConversationInvitationSearchFilter",
- "field": "INVITATION_TYPE",
- "operator": {
- "$_type": "EqualsInvitationCreatorTypeOperator",
- "type": "EQUALS",
- "value": "WEB_API"
}
}
$_type | string Default: "CustomExternalMessengerChannel" Value: "CustomExternalMessengerChannel" |
id | string Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway. |
creationTimestamp | integer <int64> Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
modificationTimestamp | integer <int64> Timestamp of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
version | integer <int64> Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted. |
accountId | string Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
name | string Name of the channel. Needs to be unique in the account. |
description | string Optional description of the channel |
string or Avatar (object) expand-query-key: channelIcon type: ExpandableField Channel icon of the entity: id that can be expanded. | |
sourceId | string Custom identifier to find the source of the channel. |
type | string (EExternalMessengerChannelType) Enum: "CUSTOM" "WHATS_APP" "FACEBOOK" enum-descriptions: ["CUSTOM: Custom channel which is connected via rest and webhooks","WHATS_APP: WhatsApp channel which is managed by the collaboration server","FACEBOOK: Facebook channel which is managed by the collaboration server"] The type of the external messenger channel |
webhookEndpoint | string The endpoint url of the webhook registration. To this url the requests for the webhook events are done. Maximum length of 4000 characters. Can not be omitted. |
webhookSecret | string A secret which is send with each webhook event. Maximum length of 4000 characters. Can be omitted. |
webhookStatus | string (ERegistrationStatus) Enum: "ACTIVE" "INACTIVE" "INACTIVE_UNAVAILABLE" enum-descriptions: ["ACTIVE: Registration is active","INACTIVE: Registration is not active","INACTIVE_UNAVAILABLE: Registration is not active, because it is unavailable"] Possible Webhook Registration Status |
messageStateHandledExternally | boolean Defines if the delivered/read state of messages is handled externally or by the collaboration server. |
object expand-query-key: metadata type: Map The entity's metadata properties. Only contains values when the 'expand' query parameter is used with the value 'metadata'. |
{- "$_type": "CustomExternalMessengerChannel",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "name": "string",
- "description": "string",
- "channelIcon": "string",
- "sourceId": "string",
- "type": "CUSTOM",
- "webhookEndpoint": "string",
- "webhookSecret": "string",
- "webhookStatus": "ACTIVE",
- "messageStateHandledExternally": true,
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}
$_type | string Default: "DefaultTemplateConversationTemplateSearchFilter" Value: "DefaultTemplateConversationTemplateSearchFilter" |
field | string (EConversationTemplateSearchFilterField) Enum: "NAME" "DESCRIPTION" "DEFAULT_TEMPLATE" "INITIAL_ENGAGEMENT_TYPE" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["NAME: Filter by the 'name' attribute","DESCRIPTION: Filter by the 'description' attribute","DEFAULT_TEMPLATE: Filter by the 'defaultTemplate' attribute","INITIAL_ENGAGEMENT_TYPE: Filter by the 'initialEngagementType' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] |
any (BooleanOperator) |
{- "$_type": "DefaultTemplateConversationTemplateSearchFilter",
- "field": "NAME",
- "operator": {
- "$_type": "EqualsBooleanOperator",
- "type": "EQUALS",
- "value": true
}
}
$_type | string Default: "DescriptionApiKeySearchFilter" Value: "DescriptionApiKeySearchFilter" |
field | string (EApiKeySearchFilterField) Enum: "NAME" "DESCRIPTION" "API_KEY" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["NAME: Filter by the 'name' attribute","DESCRIPTION: Filter by the 'description' attribute","API_KEY: Filter by the 'apiKey' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] |
any (StringOperator) |
{- "$_type": "DescriptionApiKeySearchFilter",
- "field": "NAME",
- "operator": {
- "$_type": "EqualsStringOperator",
- "type": "EQUALS",
- "value": "string"
}
}
$_type | string Default: "DescriptionConversationTemplateSearchFilter" Value: "DescriptionConversationTemplateSearchFilter" |
field | string (EConversationTemplateSearchFilterField) Enum: "NAME" "DESCRIPTION" "DEFAULT_TEMPLATE" "INITIAL_ENGAGEMENT_TYPE" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["NAME: Filter by the 'name' attribute","DESCRIPTION: Filter by the 'description' attribute","DEFAULT_TEMPLATE: Filter by the 'defaultTemplate' attribute","INITIAL_ENGAGEMENT_TYPE: Filter by the 'initialEngagementType' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] |
any (StringOperator) |
{- "$_type": "DescriptionConversationTemplateSearchFilter",
- "field": "NAME",
- "operator": {
- "$_type": "EqualsStringOperator",
- "type": "EQUALS",
- "value": "string"
}
}
$_type | string Default: "DescriptionNamedAreaSearchFilter" Value: "DescriptionNamedAreaSearchFilter" |
field | string (ENamedAreaSearchFilterField) Enum: "NAME" "DESCRIPTION" "SITE_ID" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["NAME: Filter by the 'name' attribute","DESCRIPTION: Filter by the 'description' attribute","SITE_ID: Filter by the 'siteId' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] |
any (StringOperator) |
{- "$_type": "DescriptionNamedAreaSearchFilter",
- "field": "NAME",
- "operator": {
- "$_type": "EqualsStringOperator",
- "type": "EQUALS",
- "value": "string"
}
}
$_type | string Default: "DescriptionTeamSearchFilter" Value: "DescriptionTeamSearchFilter" |
field | string (ETeamSearchFilterField) Enum: "NAME" "DESCRIPTION" "PARENT_ID" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["NAME: Filter by the 'name' attribute","DESCRIPTION: Filter by the 'description' attribute","PARENT_ID: Filter by the 'parentId' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] |
any (StringOperator) |
{- "$_type": "DescriptionTeamSearchFilter",
- "field": "NAME",
- "operator": {
- "$_type": "EqualsStringOperator",
- "type": "EQUALS",
- "value": "string"
}
}
$_type | string Default: "DescriptionWebhookRegistrationSearchFilter" Value: "DescriptionWebhookRegistrationSearchFilter" |
field | string (EWebhookRegistrationSearchFilterField) Enum: "NAME" "DESCRIPTION" "ENDPOINT" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["NAME: Sort by the 'name' attribute","DESCRIPTION: Sort by the 'description' attribute","ENDPOINT: Sort by the 'endpoint' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] |
any (StringOperator) |
{- "$_type": "DescriptionWebhookRegistrationSearchFilter",
- "field": "NAME",
- "operator": {
- "$_type": "EqualsStringOperator",
- "type": "EQUALS",
- "value": "string"
}
}
$_type | string Default: "DeviceInfo" Value: "DeviceInfo" |
id | string Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway. |
creationTimestamp | integer <int64> Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
modificationTimestamp | integer <int64> Timestamp of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
accountId | string Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
osName | string Operation system name |
osVersion | string Operation system version |
browserName | string Browser name |
browserVersion | string Browser version |
userAgent | string Original user agent string from the browser |
screenWidth | integer <int32> Screen width of the device |
screenHeight | integer <int32> Screen height of the device |
screenPixelRatio | number <float> Screen pixel ratio of the device |
type | string (EDeviceType) Enum: "MOBILE" "DESKTOP" enum-descriptions: ["MOBILE: Mobile phone / tablet / etc","DESKTOP: Desktop computer"] The device type of the physical device |
identifier | string Device identifier (via fingerprinting in browser or device id for MobileSDK) |
identifierSource | string (EIdentifierSource) Enum: "COOKIE" "DEVICE_ID" enum-descriptions: ["COOKIE: Cookie from browser","DEVICE_ID: Device id of MobileSDK"] The source of the identifier (for devices) |
pushToken | string Token for pushing via FireBase. |
ownerPersonId | string The person id of the device info owner |
{- "$_type": "DeviceInfo",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "accountId": "string",
- "osName": "string",
- "osVersion": "string",
- "browserName": "string",
- "browserVersion": "string",
- "userAgent": "string",
- "screenWidth": 0,
- "screenHeight": 0,
- "screenPixelRatio": 0,
- "type": "MOBILE",
- "identifier": "string",
- "identifierSource": "COOKIE",
- "pushToken": "string",
- "ownerPersonId": "string"
}
$_type | string Default: "DialogBotData" Value: "DialogBotData" |
id | string Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway. |
creationTimestamp | integer <int64> Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
modificationTimestamp | integer <int64> Timestamp of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
version | integer <int64> Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted. |
accountId | string Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
name | string Name of the dialog bot. Maximum length of 250 characters. Can not be omitted. |
description | string Description of the dialog bot. Maximum length of 500 characters. Can be omitted. |
botPersonId | string ID of the person representing the bot |
webhookStatus | string (ERegistrationStatus) Enum: "ACTIVE" "INACTIVE" "INACTIVE_UNAVAILABLE" enum-descriptions: ["ACTIVE: Registration is active","INACTIVE: Registration is not active","INACTIVE_UNAVAILABLE: Registration is not active, because it is unavailable"] Possible Webhook Registration Status |
webhookEndpoint | string The endpoint url of the webhook registration. To this url the requests for the webhook events are done. Maximum length of 4000 characters. Based on the configured filters/flags the following events will be sent to the endpoint:
|
webhookSecret | string Optional secret which is send with each webhook event. Maximum length of 4000 characters. |
onboardingOrder | integer <int32> Defines the onboarding order of this bot. If more than one bots want to participate in an onboarding, the one with the lowest order value will go first. |
reboardingOrder | integer <int32> Defines the reboarding order of this bot. If more than one bots want to participate in an reboarding, the one with the lowest order value will go first. |
offboardingOrder | integer <int32> Defines the offboarding priority of this bot. If more than one bots want to participate in an offboarding, the one with the lowest order value will go first. |
onboardingFilter | string (EBotDialogFilter) Enum: "VISITORS" "AGENTS" "BOTH" "NONE" enum-descriptions: ["VISITORS: Only handle dialogs that with visitors as the counterpart.","AGENTS: Only handle dialogs with agents as the counterpart","BOTH: Handle dialogs with both agents and visitors as the counterpart","NONE: Don't handle any dialogs."] |
reboardingEnabled | boolean Defines if this bot can reboard. A reboarding offer will be sent only if this flag is enabled, giving the bot the chance to be part of the reboarding. |
offboardingFilter | string (EBotDialogFilter) Enum: "VISITORS" "AGENTS" "BOTH" "NONE" enum-descriptions: ["VISITORS: Only handle dialogs that with visitors as the counterpart.","AGENTS: Only handle dialogs with agents as the counterpart","BOTH: Handle dialogs with both agents and visitors as the counterpart","NONE: Don't handle any dialogs."] |
needsCounterpartPresence | boolean Defines if the counterpart has to be online for the onboarding to start. E.g. if questions have to be answered live. |
messageStateHandledExternally | boolean Defines if the delivered/read state of messages is handled externally or by the collaboration server. |
onTimeoutBehavior | string (EBotDialogTimeoutBehavior) Enum: "ABORT" "HAND_OFF" enum-descriptions: ["ABORT: Abort on-boarding the conversation when it comes to timeout. Default for internal bots.","HAND_OFF: Proceed further in on-boarding the conversation when it comes to timeout. Default for external bots."] Defines what should happen with the conversation when it comes to timeout during on-boarding. |
{- "$_type": "DialogBotData",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "name": "string",
- "description": "string",
- "botPersonId": "string",
- "webhookStatus": "ACTIVE",
- "webhookEndpoint": "string",
- "webhookSecret": "string",
- "onboardingOrder": 0,
- "reboardingOrder": 0,
- "offboardingOrder": 0,
- "onboardingFilter": "VISITORS",
- "reboardingEnabled": true,
- "offboardingFilter": "VISITORS",
- "needsCounterpartPresence": true,
- "messageStateHandledExternally": true,
- "onTimeoutBehavior": "ABORT"
}
$_type | string Default: "DialogBotOrderBy" Value: "DialogBotOrderBy" |
field | string (EDialogBotOrderByField) Enum: "ID" "NAME" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["ID: Sort by the 'id' attribute","NAME: Sort by the 'name' attribute","CREATION_TIMESTAMP: Sort by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Sort by the 'modificationTimestamp' attribute"] |
order | string (Order) Enum: "ASCENDING" "DESCENDING" enum-descriptions: ["ASCENDING: Sort in the ascending order (smallest to largest, 0 to 9, and/or A to Z)","DESCENDING: Sort in the descending order (largest to smallest, 9 to 0, and/or Z to A)"] |
{- "$_type": "DialogBotOrderBy",
- "field": "ID",
- "order": "ASCENDING"
}
$_type | string Default: "DialogBotQuery" Value: "DialogBotQuery" |
Array of any (DialogBotSearchFilter) [ items ] List of filters to narrow the search of entities | |
Array of objects (DialogBotOrderBy) [ items ] List of criteria to order the search result list | |
offset | integer <int32> Offset position in the result set to start pagination |
limit | integer <int32> Maximal amount of items returned |
{- "$_type": "DialogBotQuery",
- "searchFilters": [
- {
- "$_type": "CreationTimestampDialogBotSearchFilter",
- "field": "NAME",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
], - "orderBy": [
- {
- "$_type": "DialogBotOrderBy",
- "field": "ID",
- "order": "ASCENDING"
}
], - "offset": 0,
- "limit": 0
}
$_type | string Default: "DialogBotResult" Value: "DialogBotResult" |
hasMoreItems | boolean Flag to indicate if there are more items on the server |
nextOffset | integer <int32> If more items are present on the server, this value can be used as offset in the next query |
Array of objects (DialogBotData) [ items ] The returned list of entities |
{- "$_type": "DialogBotResult",
- "hasMoreItems": true,
- "nextOffset": 0,
- "items": [
- {
- "$_type": "DialogBotData",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "name": "string",
- "description": "string",
- "botPersonId": "string",
- "webhookStatus": "ACTIVE",
- "webhookEndpoint": "string",
- "webhookSecret": "string",
- "onboardingOrder": 0,
- "reboardingOrder": 0,
- "offboardingOrder": 0,
- "onboardingFilter": "VISITORS",
- "reboardingEnabled": true,
- "offboardingFilter": "VISITORS",
- "needsCounterpartPresence": true,
- "messageStateHandledExternally": true,
- "onTimeoutBehavior": "ABORT"
}
]
}
$_type | string Default: "CreationTimestampDialogBotSearchFilter" Value: "CreationTimestampDialogBotSearchFilter" |
field | string (EDialogBotSearchFilterField) enum-descriptions: ["NAME: Filter by the 'name' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] CREATION_TIMESTAMP NAME CREATION_TIMESTAMP MODIFICATION_TIMESTAMP |
any (TimestampOperator) |
{- "$_type": "CreationTimestampDialogBotSearchFilter",
- "field": "CREATION_TIMESTAMP",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
$_type | string Default: "Domain" Value: "Domain" |
id | string Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway. |
creationTimestamp | integer <int64> Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
modificationTimestamp | integer <int64> Timestamp of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
version | integer <int64> Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted. |
accountId | string Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
domainName | string The name/adress of the domain. It should normally contain a protocol (e.g. http:// or https://) and the url of the domain (e.g. www.unblu.com). Maximum of 250 characters. Can not be omitted. 250 characters. |
{- "$_type": "Domain",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "domainName": "string"
}
$_type | string Default: "DomainModificationEvent" Value: "DomainModificationEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
action | string (EntityModificationAction) Enum: "CREATE" "UPDATE" "DELETE" enum-descriptions: ["CREATE: Entity was created","UPDATE: Entity was updated","DELETE: Entity was deleted"] Type of modification of an entity |
object (Domain) Model of a domain | |
object (UserInfo) User information which are normally used together with webhook events. |
{- "$_type": "DomainModificationEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "action": "CREATE",
- "entity": {
- "$_type": "Domain",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "domainName": "string"
}, - "editingUser": {
- "$_type": "UserInfo",
- "userId": "string",
- "userName": "string",
- "firstName": "string",
- "lastName": "string",
- "displayName": "string"
}
}
$_type | string Default: "DomainNameDomainSearchFilter" Value: "DomainNameDomainSearchFilter" |
field | string (EDomainSearchFilterField) Enum: "DOMAIN_NAME" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["DOMAIN_NAME: Filter by the 'domainName' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] |
any (StringOperator) |
{- "$_type": "DomainNameDomainSearchFilter",
- "field": "DOMAIN_NAME",
- "operator": {
- "$_type": "EqualsStringOperator",
- "type": "EQUALS",
- "value": "string"
}
}
$_type | string Default: "DomainOrderBy" Value: "DomainOrderBy" |
field | string (EDomainOrderByField) Enum: "ID" "DOMAIN_NAME" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["ID: Sort by the 'id' attribute","DOMAIN_NAME: Sort by the 'domainName' attribute","CREATION_TIMESTAMP: Sort by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Sort by the 'modificationTimestamp' attribute"] |
order | string (Order) Enum: "ASCENDING" "DESCENDING" enum-descriptions: ["ASCENDING: Sort in the ascending order (smallest to largest, 0 to 9, and/or A to Z)","DESCENDING: Sort in the descending order (largest to smallest, 9 to 0, and/or Z to A)"] |
{- "$_type": "DomainOrderBy",
- "field": "ID",
- "order": "ASCENDING"
}
$_type | string Default: "DomainQuery" Value: "DomainQuery" |
Array of any (DomainSearchFilter) [ items ] List of filters to narrow the search of entities | |
Array of objects (DomainOrderBy) [ items ] List of criteria to order the search result list | |
offset | integer <int32> Offset position in the result set to start pagination |
limit | integer <int32> Maximal amount of items returned |
{- "$_type": "DomainQuery",
- "searchFilters": [
- {
- "$_type": "CreationTimestampDomainSearchFilter",
- "field": "DOMAIN_NAME",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
], - "orderBy": [
- {
- "$_type": "DomainOrderBy",
- "field": "ID",
- "order": "ASCENDING"
}
], - "offset": 0,
- "limit": 0
}
$_type | string Default: "DomainResult" Value: "DomainResult" |
hasMoreItems | boolean Flag to indicate if there are more items on the server |
nextOffset | integer <int32> If more items are present on the server, this value can be used as offset in the next query |
Array of objects (Domain) [ items ] The returned list of entities |
{- "$_type": "DomainResult",
- "hasMoreItems": true,
- "nextOffset": 0,
- "items": [
- {
- "$_type": "Domain",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "domainName": "string"
}
]
}
$_type | string Default: "CreationTimestampDomainSearchFilter" Value: "CreationTimestampDomainSearchFilter" |
field | string (EDomainSearchFilterField) enum-descriptions: ["DOMAIN_NAME: Filter by the 'domainName' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] CREATION_TIMESTAMP DOMAIN_NAME CREATION_TIMESTAMP MODIFICATION_TIMESTAMP |
any (TimestampOperator) |
{- "$_type": "CreationTimestampDomainSearchFilter",
- "field": "CREATION_TIMESTAMP",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
"ID"
"NAME"
"ID"
"CREATION_TIMESTAMP"
"KEEP_AGENTS"
The state of a question message
"PENDING"
"ID"
"NAME"
The authorization role is mainly used for access definition of a service
"SUPER_ADMIN"
"EQUALS"
Possible state for agents availability
"AVAILABLE"
"EQUALS"
"VISITORS"
Reason why a bot finished a dialog.
"HAND_OFF"
Defines what should happen with the conversation when it comes to timeout during on-boarding.
When omitted the default for external bots is set to HAND_OFF.
"ABORT"
Type of a bot dialog
"ONBOARDING"
Determines the reason why the participation on a call ended.
"MISSED_BECAUSE_TIMEOUT"
State of the call
"IDLE"
Type of the call
"AUDIO"
"ID"
"KEY"
"ID"
"CREATION_TIMESTAMP"
Type of a contact information
"UNKNOWN_PHONE"
Closing reason of a conversation
"ENDED_BY_PARTICIPANT"
"EQUALS"
Status of a file which is/was uploaded to the collaboration server
"IN_PROGRESS"
"TYPE"
"INVITATION_TYPE"
Participation left reason of a conversation
"FORWARDED"
Type of link used to accept an invitation.
"ACCEPT_IN_AGENT_DESK"
Type of message action used in Card and List messages.
"LINK_INTERNAL"
How text in a conversation message should be interpreted.
"SIMPLE_TEXT"
"CREATION_TIMESTAMP"
The state of a participation inside a conversation. Following transitions are possible:
CREATED
--> ONBOARDING
, OFFBOARDING
, ACTIVE
ONBOARDING
--> ACTIVE
, OFFBOARDING
ACTIVE
--> OFFBOARDING
OFFBOARDING
--> ENDED
ENDED
--> none"CREATED"
Recipient type of the conversation
"AGENT"
"EQUALS"
"CREATION_TIMESTAMP"
Life cycle state of the conversation. Following transitions are possible:
CREATED
--> ONBOARDING
, OFFBOARDING
ONBOARDING
--> QUEUED
, ACTIVE
, OFFBOARDING
, UNASSIGNED
REBOARDING
--> QUEUED
, OFFBOARDING
QUEUED
--> ACTIVE
, OFFBOARDING
ACTIVE
--> UNASSIGNED
, OFFBOARDING
UNASSIGNED
--> REBOARDING
, OFFBOARDING
OFFBOARDING
--> ENDED
ENDED
--> none"CREATED"
"EQUALS"
"ID"
"NAME"
The device type of the physical device
"MOBILE"
"ID"
"NAME"
"ID"
"DOMAIN_NAME"
"ID"
"NAME"
The type of the external messenger channel
"CUSTOM"
Operator types corresponding to operators defined by IdListOperator
"ALL_OF"
Operator types corresponding to operators defined by IdOperator
"EQUALS"
The source of the identifier (for devices)
"COOKIE"
Type of impersonation
"NONE"
The initial type of a conversation. The type used at creation time of the conversation determines the conversation template that is used.
"CHAT_REQUEST"
"EQUALS"
The type of the person/system who created an invitation
"WEB_API"
"EQUALS"
Reuses names of values from EInvitationStatus
and adds EXPIRED value.
"OPEN"
"ANONYMOUS"
"EQUALS"
"CONVERSATION_REQUEST"
"EQUALS"
State of the global server license
"NO_LICENSE"
"EQUALS"
"ID"
"SEND_TIMESTAMP"
The state of a message if it was delivered or read
"DELIVERED"
The message type of a conversation message
"TEXT"
Type of a HTTP method
"GET"
"ID"
"NAME"
Type of a named area
"META_TAG"
Reason why the offboarding from a conversation was triggered for an individual person.
"FORWARDED"
"ID"
"CREATION_TIMESTAMP"
"JOINED_TIMESTAMP"
"PERSON_SOURCE"
The source type of a person (participant of a conversation)
"USER_DB"
"EQUALS"
The type of a person (participant of a session)
"AGENT"
"EQUALS"
Type of a message which is send to the collaboration server
"TEXT"
Type of an owner of an entity
"GLOBAL"
Reason why a question message was not answered
"TIMEDOUT"
Location where a webhook event can be registered.
"WEBHOOK_REGISTRATION"
Possible Webhook Registration Status
"ACTIVE"
Token type
"JWT"
The failed state of a message which was sent to an external messenger
"RETRYABLE"
"EQUALS"
"ID"
"NAME"
Type of a question message. Defines the reply value of a text message.
"SHORT_TEXT"
"EQUALS"
"ID"
"FIRST_NAME"
Version of the Web-API. Version of API corresponds to a path element of the request URL. E.g.: /rest/v3/<service>/...
"V1"
"ID"
"EVENT_NAME"
"ID"
"NAME"
$_type | string Default: "EmailPersonSearchFilter" Value: "EmailPersonSearchFilter" |
field | string (EPersonSearchFilterField) Enum: "PERSON_SOURCE" "SOURCE_ID" "SOURCE_DATA" "FIRST_NAME" "LAST_NAME" "USERNAME" "NICKNAME" "PERSON_TYPE" "AUTHORIZATION_ROLE" "EMAIL" "PHONE" "TEAM_ID" enum-descriptions: ["PERSON_SOURCE: Filter by the 'personSource' attribute","SOURCE_ID: Filter by the 'sourceId' attribute","SOURCE_DATA: Filter by the 'sourceData' attribute","FIRST_NAME: Filter by the 'firstName' attribute","LAST_NAME: Filter by the 'lastName' attribute","USERNAME: Filter by the 'username' attribute","NICKNAME: Filter by the 'nickname' attribute","PERSON_TYPE: Filter by the 'personType' attribute","AUTHORIZATION_ROLE: Filter by the 'authorizationRole' attribute","EMAIL: Filter by the 'email' attribute","PHONE: Filter by the 'phone' attribute","TEAM_ID: Filter by the 'teamId' attribute"] |
any (StringOperator) |
{- "$_type": "EmailPersonSearchFilter",
- "field": "PERSON_SOURCE",
- "operator": {
- "$_type": "EqualsStringOperator",
- "type": "EQUALS",
- "value": "string"
}
}
$_type | string Default: "EmailUserSearchFilter" Value: "EmailUserSearchFilter" |
field | string (EUserSearchFilterField) Enum: "FIRST_NAME" "LAST_NAME" "USERNAME" "TEAM_ID" "EMAIL" "AUTHORIZATION_ROLE" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" "VIRTUAL_USER" enum-descriptions: ["FIRST_NAME: Filter by the 'firstName' attribute","LAST_NAME: Filter by the 'lastName' attribute","USERNAME: Filter by the 'username' attribute","TEAM_ID: Filter by the 'teamId' attribute","EMAIL: Filter by the 'email' attribute","AUTHORIZATION_ROLE: Filter by the 'authorizationRole' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute","VIRTUAL_USER: Filter by the 'virtualUser' attribute"] |
any (StringOperator) |
{- "$_type": "EmailUserSearchFilter",
- "field": "FIRST_NAME",
- "operator": {
- "$_type": "EqualsStringOperator",
- "type": "EQUALS",
- "value": "string"
}
}
$_type | string Default: "EndReasonConversationSearchFilter" Value: "EndReasonConversationSearchFilter" |
field | string (EConversationSearchFilterField) Enum: "CREATION_TIMESTAMP" "END_TIMESTAMP" "INITIAL_ENGAGEMENT_TYPE" "TOPIC" "CONTEXT_PERSON_ID" "ASSIGNEE_PERSON_ID" "PARTICIPANT_PERSON_ID" "STATE" "END_REASON" "CONVERSATION_TEMPLATE_ID" "RECIPIENT_ID" "RECIPIENT_TYPE" "TOKBOX_SESSION_ID" enum-descriptions: ["CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","END_TIMESTAMP: Filter by the 'endTimestamp' attribute","INITIAL_ENGAGEMENT_TYPE: Filter by the 'initialEngagementType' attribute","TOPIC: Filter by the 'topic' attribute","CONTEXT_PERSON_ID: Filter by the 'contextPersonId' attribute","ASSIGNEE_PERSON_ID: Filter by the 'assigneePersonId' attribute","PARTICIPANT_PERSON_ID: Filter by the 'personId' of the participants","STATE: Filter by the 'state' attribute","END_REASON: Filter by the 'endReason' attribute","CONVERSATION_TEMPLATE_ID: Filter by the 'conversationTemplateId' attribute","RECIPIENT_ID: Filter by the 'id' of the 'recipient' attribute","RECIPIENT_TYPE: Filter by the 'type' of the 'recipient' attribute","TOKBOX_SESSION_ID: Filter by the 'tokboxSessionId' attribute"] |
any (ConversationEndReasonOperator) |
{- "$_type": "EndReasonConversationSearchFilter",
- "field": "CREATION_TIMESTAMP",
- "operator": {
- "$_type": "EqualsConversationEndReasonOperator",
- "type": "EQUALS",
- "value": "ENDED_BY_PARTICIPANT"
}
}
$_type | string Default: "EndTimestampConversationSearchFilter" Value: "EndTimestampConversationSearchFilter" |
field | string (EConversationSearchFilterField) Enum: "CREATION_TIMESTAMP" "END_TIMESTAMP" "INITIAL_ENGAGEMENT_TYPE" "TOPIC" "CONTEXT_PERSON_ID" "ASSIGNEE_PERSON_ID" "PARTICIPANT_PERSON_ID" "STATE" "END_REASON" "CONVERSATION_TEMPLATE_ID" "RECIPIENT_ID" "RECIPIENT_TYPE" "TOKBOX_SESSION_ID" enum-descriptions: ["CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","END_TIMESTAMP: Filter by the 'endTimestamp' attribute","INITIAL_ENGAGEMENT_TYPE: Filter by the 'initialEngagementType' attribute","TOPIC: Filter by the 'topic' attribute","CONTEXT_PERSON_ID: Filter by the 'contextPersonId' attribute","ASSIGNEE_PERSON_ID: Filter by the 'assigneePersonId' attribute","PARTICIPANT_PERSON_ID: Filter by the 'personId' of the participants","STATE: Filter by the 'state' attribute","END_REASON: Filter by the 'endReason' attribute","CONVERSATION_TEMPLATE_ID: Filter by the 'conversationTemplateId' attribute","RECIPIENT_ID: Filter by the 'id' of the 'recipient' attribute","RECIPIENT_TYPE: Filter by the 'type' of the 'recipient' attribute","TOKBOX_SESSION_ID: Filter by the 'tokboxSessionId' attribute"] |
any (TimestampOperator) |
{- "$_type": "EndTimestampConversationSearchFilter",
- "field": "CREATION_TIMESTAMP",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
$_type | string Default: "EndpointWebhookCallLogSearchFilter" Value: "EndpointWebhookCallLogSearchFilter" |
field | string (EWebhookCallLogSearchFilterField) Enum: "EVENT_NAME" "REGISTRATION_ID" "REQUEST_ID" "EXECUTION_TIMESTAMP" "ENDPOINT" "RETRY_NR" "CREATION_TIMESTAMP" "HTTP_RESPONSE_CODE" enum-descriptions: ["EVENT_NAME: Filter by the 'eventName' attribute","REGISTRATION_ID: Filter by the 'registrationId' attribute","REQUEST_ID: Filter by the 'requestId' attribute","EXECUTION_TIMESTAMP: Filter by the 'executionTimestamp' attribute","ENDPOINT: Filter by the 'endpoint' attribute","RETRY_NR: Filter by the 'retryNr' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","HTTP_RESPONSE_CODE: Filter by the 'httpResponseCode' attribute"] |
any (StringOperator) |
{- "$_type": "EndpointWebhookCallLogSearchFilter",
- "field": "EVENT_NAME",
- "operator": {
- "$_type": "EqualsStringOperator",
- "type": "EQUALS",
- "value": "string"
}
}
$_type | string Default: "EndpointWebhookRegistrationSearchFilter" Value: "EndpointWebhookRegistrationSearchFilter" |
field | string (EWebhookRegistrationSearchFilterField) Enum: "NAME" "DESCRIPTION" "ENDPOINT" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["NAME: Sort by the 'name' attribute","DESCRIPTION: Sort by the 'description' attribute","ENDPOINT: Sort by the 'endpoint' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] |
any (StringOperator) |
{- "$_type": "EndpointWebhookRegistrationSearchFilter",
- "field": "NAME",
- "operator": {
- "$_type": "EqualsStringOperator",
- "type": "EQUALS",
- "value": "string"
}
}
Type of modification of an entity
"CREATE"
$_type | string Default: "EqualsAuthorizationRoleOperator" Value: "EqualsAuthorizationRoleOperator" |
type | string (EAuthorizationRoleOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator"] |
value | string (EAuthorizationRole) Enum: "SUPER_ADMIN" "PARTNER" "TECHNICAL_ADMIN" "ADMIN" "SUPERVISOR" "REGISTERED_USER" "WEBUSER" "ANONYMOUS_USER" enum-descriptions: ["SUPER_ADMIN: Super admin role. Only for unblu or system admins","PARTNER: Partner role. (no longer used)","TECHNICAL_ADMIN: Technical admin role.","ADMIN: Admin role. For Admins of the system","SUPERVISOR: Supervisor role. For users which manage teams","REGISTERED_USER: User role. For normal users (agents)","WEBUSER: Webuser role. For internal representation of users from the outside","ANONYMOUS_USER: Anonymous role. For internal representation of unknown users"] The authorization role is mainly used for access definition of a service |
{- "$_type": "EqualsAuthorizationRoleOperator",
- "type": "EQUALS",
- "value": "SUPER_ADMIN"
}
$_type | string Default: "EqualsBooleanOperator" Value: "EqualsBooleanOperator" |
type | string (EBooleanOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IS_NULL" "IS_NOT_NULL" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IS_NULL: Check if the value is null","IS_NOT_NULL: Check if the value is not null"] |
value | boolean |
{- "$_type": "EqualsBooleanOperator",
- "type": "EQUALS",
- "value": true
}
$_type | string Default: "EqualsConversationEndReasonOperator" Value: "EqualsConversationEndReasonOperator" |
type | string (EConversationEndReasonOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator"] |
value | string (EConversationEndReason) Enum: "ENDED_BY_PARTICIPANT" "MANDATORY_PARTICIPANT_GONE" "EXTERNAL_CHANNEL_CLOSED" "SOLVED_BY_BOT" "OTHER" enum-descriptions: ["ENDED_BY_PARTICIPANT","MANDATORY_PARTICIPANT_GONE","EXTERNAL_CHANNEL_CLOSED","SOLVED_BY_BOT","OTHER"] Closing reason of a conversation |
{- "$_type": "EqualsConversationEndReasonOperator",
- "type": "EQUALS",
- "value": "ENDED_BY_PARTICIPANT"
}
$_type | string Default: "EqualsConversationRecipientTypeOperator" Value: "EqualsConversationRecipientTypeOperator" |
type | string (EConversationRecipientTypeOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator"] |
value | string (EConversationRecipientType) Enum: "AGENT" "TEAM" "NAMED_AREA" "ACCOUNT" enum-descriptions: ["AGENT: Recipient is a single agent","TEAM: Recipient is an agent of the team","NAMED_AREA: Recipient is an agent responsible for a specific named-area","ACCOUNT: Recipient is one of all the agents of an account"] Recipient type of the conversation |
{- "$_type": "EqualsConversationRecipientTypeOperator",
- "type": "EQUALS",
- "value": "AGENT"
}
$_type | string Default: "EqualsConversationStateOperator" Value: "EqualsConversationStateOperator" |
type | string (EConversationStateOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator"] |
value | string (EConversationState) Enum: "CREATED" "ONBOARDING" "REBOARDING" "QUEUED" "ACTIVE" "UNASSIGNED" "OFFBOARDING" "ENDED" enum-descriptions: ["CREATED: Initial state of a conversation","ONBOARDING: Depending of the engagement type of the conversation, the conversation stays in the onboarding state as long as the person in the center of the conversation is doing his onboarding","REBOARDING: When a message is send to an unassigned conversation, the conversation first is put into the reboarding state as long as the person in the center of the conversation is doing the reboarding.","QUEUED: Depending of the engagement type of the conversation, the conversation is put in the queued state when it is inside the queue.","ACTIVE: Conversation is active","UNASSIGNED: After there is no assignee of a conversation anymore, the conversation goes to unassigned state until a message from a visitor is written to start reboarding again.","OFFBOARDING: Conversation is being ended","ENDED: Conversation is ended"] Life cycle state of the conversation. Following transitions are possible:
|
{- "$_type": "EqualsConversationStateOperator",
- "type": "EQUALS",
- "value": "CREATED"
}
$_type | string Default: "EqualsIdOperator" Value: "EqualsIdOperator" |
type | string (EIdOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" "IS_NULL" "IS_NOT_NULL" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator","IS_NULL: Check if the value is null","IS_NOT_NULL: Check if the value is not null"] Operator types corresponding to operators defined by |
value | string |
{- "$_type": "EqualsIdOperator",
- "type": "EQUALS",
- "value": "string"
}
$_type | string Default: "EqualsInitialEngagementTypeOperator" Value: "EqualsInitialEngagementTypeOperator" |
type | string (EInitialEngagementTypeOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator"] |
value | string (EInitialEngagementType) Enum: "CHAT_REQUEST" "OFFLINE_CHAT_REQUEST" "VIDEO_REQUEST" "AUDIO_REQUEST" "HEADLESS_BROWSER_REQUEST" "DOMCAP_BROWSER_REQUEST" "MOBILE_COBROWSING_REQUEST" "SCREEN_SHARING_REQUEST" "VISITOR_COBROWSING" "HEADLESS_PIN" "DOMCAP_PIN" "MOBILE_PIN" "SCREEN_SHARING_PIN" "CHAT_INVITE" "HEADLESS_INVITE" "SCREEN_SHARING_INVITE" enum-descriptions: ["CHAT_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming chat conversation.","OFFLINE_CHAT_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming chat conversation while all agents are offline.","VIDEO_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming video conversation.","AUDIO_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming audio conversation.","HEADLESS_BROWSER_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming universal co-browsing conversation.","DOMCAP_BROWSER_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming embedded co-browsing conversation.","MOBILE_COBROWSING_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming mobile co-browsing conversation.","SCREEN_SHARING_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming screen sharing conversation.","VISITOR_COBROWSING: (Api initiated, visitor centered) A visitor creates a conversation via API which is not added to the queue and where he can invite other visitor to do embedded","HEADLESS_PIN: (Agent initiated, visitor centered) An agent creates a conversation with a PIN invitation for the visitor to join an universal co-browsing conversation.","DOMCAP_PIN: (Agent initiated, visitor centered) An agent creates a conversation with a PIN invitation for the visitor to join an embedded co-browsing conversation.","MOBILE_PIN: (Agent initiated, visitor centered) An agent creates a conversation with a PIN invitation for the visitor to join a mobile co-browsing conversation.","SCREEN_SHARING_PIN: (Agent initiated, visitor centered) An agent creates a conversation with a PIN invitation for the visitor to join a screen sharing conversation.","CHAT_INVITE: (Agent initiated, agent centered) An agent creates a chat conversation (this is the recommended initial engagement type for conversation created with the Web API).","HEADLESS_INVITE: (Agent initiated, agent centered) An agent creates universal co-browsing conversation and invites customer later.","SCREEN_SHARING_INVITE: (Agent initiated, agent centered) An agent creates screen sharing conversation and invites customer later."] The initial type of a conversation. The type used at creation time of the conversation determines the conversation template that is used. |
{- "$_type": "EqualsInitialEngagementTypeOperator",
- "type": "EQUALS",
- "value": "CHAT_REQUEST"
}
$_type | string Default: "EqualsInvitationCreatorTypeOperator" Value: "EqualsInvitationCreatorTypeOperator" |
type | string (EInvitationCreatorTypeOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator"] |
value | string (EInvitationCreatorType) Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR" enum-descriptions: ["WEB_API: Invitation created with the API","SYSTEM: Invitation created by the system","AGENT: Invitation created by an agent","VISITOR: Invitation created by a visitor"] The type of the person/system who created an invitation |
{- "$_type": "EqualsInvitationCreatorTypeOperator",
- "type": "EQUALS",
- "value": "WEB_API"
}
$_type | string Default: "EqualsInvitationTargetTypeOperator" Value: "EqualsInvitationTargetTypeOperator" |
type | string (EInvitationTargetTypeOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator"] |
value | string (EInvitationTargetType) Enum: "ANONYMOUS" "VISITOR" "AGENT" "TEAM" "NAMED_AREA" "ACCOUNT" enum-descriptions: ["ANONYMOUS","VISITOR","AGENT","TEAM","NAMED_AREA","ACCOUNT"] |
{- "$_type": "EqualsInvitationTargetTypeOperator",
- "type": "EQUALS",
- "value": "ANONYMOUS"
}
$_type | string Default: "EqualsInvitationTypeOperator" Value: "EqualsInvitationTypeOperator" |
type | string (EInvitationTypeOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator"] |
value | string (EInvitationType) Enum: "CONVERSATION_REQUEST" "AGENT_FORWARDING" "AGENT_INVITATION" "VISITOR_INVITATION" "PIN_CONVERSATION" enum-descriptions: ["CONVERSATION_REQUEST: All visitor conversation requests e.g. Voice / Video-Call, Co-Browsing Request, etc.","AGENT_FORWARDING: Conversation forwarding to an other agent, directly or via a team. <ul> <li>The forwarding agent will leave the conversation once it has been accepted.</li> <li>The assignee will change to the forwarded agent once it has been accepted.</li> </ul>","AGENT_INVITATION: Invites an other agent into the conversation, directly or via a team. <ul> <li>The inviting agent stays in the conversation.</li> <li>The assignee will NOT change when the invited agent accepts the invitation.</li> </ul>","VISITOR_INVITATION: Anonymous Visitor invitation <ul> <li>Anyone with the invitations ticket (and the accounts API key) may enter the conversation as a Visitor.</li> <li>Once the invitation has been redeemed it can not be reused by other Visitors.</li> </ul>","PIN_CONVERSATION: Universal / Embedded / Mobile PIN Session. <ul> <li>The conversation doesn't really start until the invitation is redeemed.</li> <li>Anyone with the invitations ticket (and the accounts API key) may enter the conversation as a Visitor.</li> <li>Once the ticket has been redeemed it can not be reused by other Visitors.</li> </ul>"] |
{- "$_type": "EqualsInvitationTypeOperator",
- "type": "EQUALS",
- "value": "CONVERSATION_REQUEST"
}
$_type | string Default: "EqualsLongOperator" Value: "EqualsLongOperator" |
type | string (ELongOperatorType) Enum: "EQUALS" "NOT_EQUALS" "GREATER_THAN" "LOWER_THAN" "IN_RANGE" "NOT_IN_RANGE" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","GREATER_THAN: Check if the value is greater than the one provided in the operator","LOWER_THAN: Check if the value is lower than the one provided in the operator","IN_RANGE: Check if the value is in the range of the provided values. Results equal to the provided values are included.","NOT_IN_RANGE: Check if the value is NOT in the range of the provided values. Results equal to the provided values are not included."] |
value | integer <int64> |
{- "$_type": "EqualsLongOperator",
- "type": "EQUALS",
- "value": 0
}
$_type | string Default: "EqualsPersonSourceOperator" Value: "EqualsPersonSourceOperator" |
type | string (EPersonSourceOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator"] |
value | string (EPersonSource) Enum: "USER_DB" "VIRTUAL" enum-descriptions: ["USER_DB: Person-Source is on the main_user table","VIRTUAL: Person-Source is only virtual (no seperate storage)"] The source type of a person (participant of a conversation) |
{- "$_type": "EqualsPersonSourceOperator",
- "type": "EQUALS",
- "value": "USER_DB"
}
$_type | string Default: "EqualsPersonTypeOperator" Value: "EqualsPersonTypeOperator" |
type | string (EPersonTypeOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator"] |
value | string (EPersonType) Enum: "AGENT" "VISITOR" "SYSTEM" "BOT" enum-descriptions: ["AGENT: Agent participant","VISITOR: Visitor participant","SYSTEM: System participant","BOT: Bot participant"] The type of a person (participant of a session) |
{- "$_type": "EqualsPersonTypeOperator",
- "type": "EQUALS",
- "value": "AGENT"
}
$_type | string Default: "EqualsStringOperator" Value: "EqualsStringOperator" |
type | string (EStringOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" "IS_NULL" "IS_NOT_NULL" "CONTAINS" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator","IS_NULL: Check if the value is null","IS_NOT_NULL: Check if the value is not null","CONTAINS: Check if the value contains the string provided in the operator"] |
value | string |
{- "$_type": "EqualsStringOperator",
- "type": "EQUALS",
- "value": "string"
}
$_type | string Default: "EqualsTimestampOperator" Value: "EqualsTimestampOperator" |
type | string (ETimestampOperatorType) Enum: "EQUALS" "NOT_EQUALS" "GREATER_THAN" "LOWER_THAN" "IN" "NOT_IN" "IS_NULL" "IS_NOT_NULL" "IN_RANGE" "NOT_IN_RANGE" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","GREATER_THAN: Check if the value is greater than the one provided in the operator","LOWER_THAN: Check if the value is lower than the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator","IS_NULL: Check if the value is null","IS_NOT_NULL: Check if the value is not null","IN_RANGE: Check if the value is in the range of the provided values. Results equal to the provided values are included.","NOT_IN_RANGE: Check if the value is NOT in the range of the provided values. Results equal to the provided values are not included."] |
value | integer <int64> |
{- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
$_type | string Default: "Error" Value: "Error" |
statusCode | integer <int32> Http status code |
statusDescription | string Reason phrase corresponding to the http status |
errorMessage | string Description of the error |
{- "$_type": "Error",
- "statusCode": 0,
- "statusDescription": "string",
- "errorMessage": "string"
}
$_type | string Default: "EventNameWebhookCallLogSearchFilter" Value: "EventNameWebhookCallLogSearchFilter" |
field | string (EWebhookCallLogSearchFilterField) Enum: "EVENT_NAME" "REGISTRATION_ID" "REQUEST_ID" "EXECUTION_TIMESTAMP" "ENDPOINT" "RETRY_NR" "CREATION_TIMESTAMP" "HTTP_RESPONSE_CODE" enum-descriptions: ["EVENT_NAME: Filter by the 'eventName' attribute","REGISTRATION_ID: Filter by the 'registrationId' attribute","REQUEST_ID: Filter by the 'requestId' attribute","EXECUTION_TIMESTAMP: Filter by the 'executionTimestamp' attribute","ENDPOINT: Filter by the 'endpoint' attribute","RETRY_NR: Filter by the 'retryNr' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","HTTP_RESPONSE_CODE: Filter by the 'httpResponseCode' attribute"] |
any (StringOperator) |
{- "$_type": "EventNameWebhookCallLogSearchFilter",
- "field": "EVENT_NAME",
- "operator": {
- "$_type": "EqualsStringOperator",
- "type": "EQUALS",
- "value": "string"
}
}
$_type | string Default: "ExecutionTimestampWebhookCallLogSearchFilter" Value: "ExecutionTimestampWebhookCallLogSearchFilter" |
field | string (EWebhookCallLogSearchFilterField) Enum: "EVENT_NAME" "REGISTRATION_ID" "REQUEST_ID" "EXECUTION_TIMESTAMP" "ENDPOINT" "RETRY_NR" "CREATION_TIMESTAMP" "HTTP_RESPONSE_CODE" enum-descriptions: ["EVENT_NAME: Filter by the 'eventName' attribute","REGISTRATION_ID: Filter by the 'registrationId' attribute","REQUEST_ID: Filter by the 'requestId' attribute","EXECUTION_TIMESTAMP: Filter by the 'executionTimestamp' attribute","ENDPOINT: Filter by the 'endpoint' attribute","RETRY_NR: Filter by the 'retryNr' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","HTTP_RESPONSE_CODE: Filter by the 'httpResponseCode' attribute"] |
any (TimestampOperator) |
{- "$_type": "ExecutionTimestampWebhookCallLogSearchFilter",
- "field": "EVENT_NAME",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
"avatar"
$_type | string Default: "ExpirationTimestampConversationInvitationSearchFilter" Value: "ExpirationTimestampConversationInvitationSearchFilter" |
field | string (EConversationInvitationSearchFilterField) Enum: "INVITATION_TYPE" "TARGET_TYPE" "CONVERSATION_ID" "TARGET_ID" "EXPIRATION_TIMESTAMP" "CREATION_TIMESTAMP" "CREATOR_TYPE" "CREATOR_PERSON_ID" "REDEEMING_PERSON_ID" enum-descriptions: ["INVITATION_TYPE: Filter by the 'type' attribute","TARGET_TYPE: Filter by the 'targetType' attribute","CONVERSATION_ID: Filter by the 'conversationId' attribute","TARGET_ID: Filter by the 'targetId' attribute","EXPIRATION_TIMESTAMP: Filter by the 'expirationTimestamp' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","CREATOR_TYPE: Filter by the 'creatorType' attribute","CREATOR_PERSON_ID: Filter by the 'creatorId' attribute","REDEEMING_PERSON_ID: Filter by the 'redeemerPersonId' attribute"] |
any (TimestampOperator) |
{- "$_type": "ExpirationTimestampConversationInvitationSearchFilter",
- "field": "INVITATION_TYPE",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
$_type | string Default: "CustomExternalMessengerChannel" CustomExternalMessengerChannel CustomExternalMessengerChannel |
id | string Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway. |
creationTimestamp | integer <int64> Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
modificationTimestamp | integer <int64> Timestamp of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
version | integer <int64> Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted. |
accountId | string Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
name | string Name of the channel. Needs to be unique in the account. |
description | string Optional description of the channel |
string or Avatar (object) expand-query-key: channelIcon type: ExpandableField Channel icon of the entity: id that can be expanded. | |
sourceId | string Custom identifier to find the source of the channel. |
type | string (EExternalMessengerChannelType) Enum: "CUSTOM" "WHATS_APP" "FACEBOOK" enum-descriptions: ["CUSTOM: Custom channel which is connected via rest and webhooks","WHATS_APP: WhatsApp channel which is managed by the collaboration server","FACEBOOK: Facebook channel which is managed by the collaboration server"] The type of the external messenger channel |
webhookEndpoint | string The endpoint url of the webhook registration. To this url the requests for the webhook events are done. Maximum length of 4000 characters. Can not be omitted. |
webhookSecret | string A secret which is send with each webhook event. Maximum length of 4000 characters. Can be omitted. |
webhookStatus | string (ERegistrationStatus) Enum: "ACTIVE" "INACTIVE" "INACTIVE_UNAVAILABLE" enum-descriptions: ["ACTIVE: Registration is active","INACTIVE: Registration is not active","INACTIVE_UNAVAILABLE: Registration is not active, because it is unavailable"] Possible Webhook Registration Status |
messageStateHandledExternally | boolean Defines if the delivered/read state of messages is handled externally or by the collaboration server. |
object expand-query-key: metadata type: Map The entity's metadata properties. Only contains values when the 'expand' query parameter is used with the value 'metadata'. |
{- "$_type": "CustomExternalMessengerChannel",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "name": "string",
- "description": "string",
- "channelIcon": "string",
- "sourceId": "string",
- "type": "CUSTOM",
- "webhookEndpoint": "string",
- "webhookSecret": "string",
- "webhookStatus": "ACTIVE",
- "messageStateHandledExternally": true,
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}
$_type | string Default: "ExternalMessengerChannelOrderBy" Value: "ExternalMessengerChannelOrderBy" |
field | string (EExternalMessengerChannelOrderByField) Enum: "ID" "NAME" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["ID: Sort by the 'id' attribute","NAME: Sort by the 'name' attribute","CREATION_TIMESTAMP: Sort by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Sort by the 'modificationTimestamp' attribute"] |
order | string (Order) Enum: "ASCENDING" "DESCENDING" enum-descriptions: ["ASCENDING: Sort in the ascending order (smallest to largest, 0 to 9, and/or A to Z)","DESCENDING: Sort in the descending order (largest to smallest, 9 to 0, and/or Z to A)"] |
{- "$_type": "ExternalMessengerChannelOrderBy",
- "field": "ID",
- "order": "ASCENDING"
}
$_type | string Default: "ExternalMessengerChannelQuery" Value: "ExternalMessengerChannelQuery" |
Array of any (ExternalMessengerChannelSearchFilter) [ items ] List of filters to narrow the search of entities | |
Array of objects (ExternalMessengerChannelOrderBy) [ items ] List of criteria to order the search result list | |
offset | integer <int32> Offset position in the result set to start pagination |
limit | integer <int32> Maximal amount of items returned |
{- "$_type": "ExternalMessengerChannelQuery",
- "searchFilters": [
- {
- "$_type": "CreationTimestampExternalMessengerChannelSearchFilter",
- "field": "NAME",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
], - "orderBy": [
- {
- "$_type": "ExternalMessengerChannelOrderBy",
- "field": "ID",
- "order": "ASCENDING"
}
], - "offset": 0,
- "limit": 0
}
$_type | string Default: "ExternalMessengerChannelResult" Value: "ExternalMessengerChannelResult" |
hasMoreItems | boolean Flag to indicate if there are more items on the server |
nextOffset | integer <int32> If more items are present on the server, this value can be used as offset in the next query |
Array of any (ExternalMessengerChannel) [ items ] The returned list of entities |
{- "$_type": "ExternalMessengerChannelResult",
- "hasMoreItems": true,
- "nextOffset": 0,
- "items": [
- {
- "$_type": "CustomExternalMessengerChannel",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "name": "string",
- "description": "string",
- "channelIcon": "string",
- "sourceId": "string",
- "type": "CUSTOM",
- "webhookEndpoint": "string",
- "webhookSecret": "string",
- "webhookStatus": "ACTIVE",
- "messageStateHandledExternally": true,
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}
]
}
$_type | string Default: "CreationTimestampExternalMessengerChannelSearchFilter" Value: "CreationTimestampExternalMessengerChannelSearchFilter" |
field | string (EExternalMessengerChannelSearchFilterField) enum-descriptions: ["NAME: Filter by the 'name' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] CREATION_TIMESTAMP NAME CREATION_TIMESTAMP MODIFICATION_TIMESTAMP |
any (TimestampOperator) |
{- "$_type": "CreationTimestampExternalMessengerChannelSearchFilter",
- "field": "CREATION_TIMESTAMP",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
$_type | string Default: "ExternalMessengerMessageStateEvent" Value: "ExternalMessengerMessageStateEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
messageId | string The id of the message which state has changed |
state | string (EMessageState) Enum: "DELIVERED" "READ" enum-descriptions: ["DELIVERED: The message was delivered to the recipients","READ: The message was read by the recipients"] The state of a message if it was delivered or read |
sourceId | string The source id of the message |
externalMessengerChannelId | string The id if the external messenger channel |
conversationId | string The conversation to which the message belongs to |
{- "$_type": "ExternalMessengerMessageStateEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "messageId": "string",
- "state": "DELIVERED",
- "sourceId": "string",
- "externalMessengerChannelId": "string",
- "conversationId": "string"
}
$_type | string Default: "ExternalMessengerNewMessageEvent" Value: "ExternalMessengerNewMessageEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
any (MessageData) Base class for all conversation messages. Can be one of |
{- "$_type": "ExternalMessengerNewMessageEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "conversationMessage": {
- "$_type": "ApprovalRequestMessageData",
- "id": "string",
- "conversationId": "string",
- "externalMessengerChannelId": "string",
- "accountId": "string",
- "senderPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "senderPersonPresenceId": "string",
- "serverTimestamp": 0,
- "sendTimestamp": 0,
- "type": "TEXT",
- "recipientPersonIds": [
- "string"
], - "fallbackText": "string",
- "actionId": "string",
- "sourceId": "string",
- "text": "string",
- "textType": "SIMPLE_TEXT",
- "options": [
- {
- "$_type": "MultichoiceQuestionOption",
- "label": "string",
- "value": "string",
- "primary": true
}
], - "answerStatus": "PENDING"
}
}
$_type | string Default: "ExternalMessengerPostMessage" Value: "ExternalMessengerPostMessage" |
conversationId | string The id of the conversation to which this message belongs to |
externalMessengerChannelId | string The id of the external messenger channel this message belongs to |
senderPersonId | string ID of the person that sent the message. |
recipientPersonIds | Array of strings Person IDs of the recipients of the message. If it is null, all active participations are recipients |
sourceId | string An id identifying the source of the external message. Typically the id of the message in the other messaging system |
any (PostMessageData) Base class for all conversation messages send to the collaboration server. |
{- "$_type": "ExternalMessengerPostMessage",
- "conversationId": "string",
- "externalMessengerChannelId": "string",
- "senderPersonId": "string",
- "recipientPersonIds": [
- "string"
], - "sourceId": "string",
- "messageData": {
- "$_type": "ListPostMessageData",
- "type": "TEXT",
- "fallbackText": "string",
- "header": {
- "$_type": "MessageHeader",
- "imageUrl": "string",
- "imageAltText": "string",
- "title": "string",
- "body": "string",
- "bodyTextType": "SIMPLE_TEXT"
}, - "items": [
- {
- "$_type": "PostListMessageCardItemData",
- "imageUrl": "string",
- "imageAltText": "string",
- "title": "string",
- "body": "string",
- "bodyTextType": "SIMPLE_TEXT",
- "action": {
- "$_type": "MessageAction",
- "actionType": "LINK_INTERNAL",
- "label": "string",
- "value": "string"
}
}
], - "actions": [
- {
- "$_type": "MessageAction",
- "actionType": "LINK_INTERNAL",
- "label": "string",
- "value": "string"
}
], - "quickReplies": [
- {
- "$_type": "QuickReply",
- "text": "string"
}
]
}
}
conversationId | string The id of the conversation |
externalMessengerChannelId | string The id of the custom external messenger channel |
messageId | string The id of the message from the conversation, which should be marked as delivered |
personId | string The id of the person who received the message. If null, it will be assumed that the message has been delivered to all persons which are connected via the external messenger. |
{- "conversationId": "string",
- "externalMessengerChannelId": "string",
- "messageId": "string",
- "personId": "string"
}
conversationId | string The id of the conversation |
externalMessengerChannelId | string The id of the custom external messenger channel |
messageId | string The id of the message from the conversation, which should be marked as read |
personId | string The id of the person who read the message. If null, it will be assumed that the message has been read by all persons which are connected via the external messenger. |
{- "conversationId": "string",
- "externalMessengerChannelId": "string",
- "messageId": "string",
- "personId": "string"
}
conversationId | string The id of the conversation |
externalMessengerChannelId | string The id of the custom external messenger channel |
messageId | string The id of the message from the conversation, which should be set to the failed state |
failedState | string (ESendFailState) Enum: "RETRYABLE" "TERMINAL" enum-descriptions: ["RETRYABLE: Message could not be sent, but it is not terminal and can be tried again","TERMINAL: Message could not be sent and it will not be possible to send it again"] The failed state of a message which was sent to an external messenger |
failureText | string A text which describes why a message could not be sent to the external messenger. This text will be displayed to the user in the UI of the message |
{- "conversationId": "string",
- "externalMessengerChannelId": "string",
- "messageId": "string",
- "failedState": "RETRYABLE",
- "failureText": "string"
}
conversationId | string The id of the conversation |
externalMessengerChannelId | string The id of the custom external messenger channel |
messageId | string The id of the message from the conversation, which was successfully sent |
{- "conversationId": "string",
- "externalMessengerChannelId": "string",
- "messageId": "string"
}
externalMessengerChannelId | string The ID of an external messenger channel of type |
{- "externalMessengerChannelId": "string"
}
$_type | string Default: "FileMessageData" Value: "FileMessageData" |
id | string The ID of the message. |
conversationId | string Conversation ID to which this message belongs to |
externalMessengerChannelId | string ID of the external messenger channel connected to the conversation. Null if the conversation is not connected to an external messenger. |
accountId | string Account ID to which this message and conversation belongs to. |
object (PersonData) Representation of a Person (Agent or Visitor). | |
senderPersonPresenceId | string Id of the person presence that sends the message. May be null if the message was sent by the system. |
serverTimestamp | integer <int64> utc timestamp when the message was received on the server. |
sendTimestamp | integer <int64> utc timestamp when the message was sent from the client |
type | string (EMessageType) Enum: "TEXT" "FILE" "CARD" "LIST" "APPROVAL_REQUEST" "MULTICHOICE_QUESTION" "RATING_QUESTION" "TEXT_QUESTION" "REPLY" "QUESTION_ABORTED" enum-descriptions: ["TEXT","FILE","CARD","LIST","APPROVAL_REQUEST","MULTICHOICE_QUESTION","RATING_QUESTION","TEXT_QUESTION","REPLY","QUESTION_ABORTED"] The message type of a conversation message |
recipientPersonIds | Array of strings Person IDs of the recipients of the message. If it is null, all active participations are recipients |
fallbackText | string Text representation of the message which is used in following cases:
The fallback text can be provided by the sender (bot, external messenger) or is generated when missing. This may however not always be a perfect textual representation of the message. |
actionId | string An ID of the action triggering the message to be able to identify a message created by an action. |
sourceId | string A custom ID which identifies where this message initially came from. |
fileName | string The name of the file that is send |
caption | string A caption for the file that is send. Can be omitted |
captionType | string (EConversationMessageTextType) Enum: "SIMPLE_TEXT" "MARKDOWN" enum-descriptions: ["SIMPLE_TEXT: Text will be interpreted as simple text. <p> Auto link detection will still be possible.","MARKDOWN: Text will be interpreted as Markdown. <p> The supported Markdown subset depends on the message type."] How text in a conversation message should be interpreted. |
mimeType | string The mime type of the file that is send |
source | string The source of the file |
fileStoreId | string The file store id of the content inside the collaboration server |
fileStatus | string (EConversationFileStatus) Enum: "IN_PROGRESS" "COMPLETED" "CANCELED" "FAILED" "DELETED" enum-descriptions: ["IN_PROGRESS","COMPLETED","CANCELED","FAILED","DELETED"] Status of a file which is/was uploaded to the collaboration server |
totalSize | integer <int64> The total size of the file. Does not need to be set, when the file is send to the collaboration server |
uploadedSize | integer <int64> The amount of data that was already uploaded to the server. Does not need to be set, when the file is send to the collaboration server |
downloadLink | string The url link to download the file. Note that the access must be done from an authenticated user with admin rights. This may either be done using basic authentication or a valid session cookie. |
Array of objects (QuickReply) [ items ] Optional quick replies which will be displayed above the chat input as a possible response options |
{- "$_type": "FileMessageData",
- "id": "string",
- "conversationId": "string",
- "externalMessengerChannelId": "string",
- "accountId": "string",
- "senderPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "senderPersonPresenceId": "string",
- "serverTimestamp": 0,
- "sendTimestamp": 0,
- "type": "TEXT",
- "recipientPersonIds": [
- "string"
], - "fallbackText": "string",
- "actionId": "string",
- "sourceId": "string",
- "fileName": "string",
- "caption": "string",
- "captionType": "SIMPLE_TEXT",
- "mimeType": "string",
- "source": "string",
- "fileStoreId": "string",
- "fileStatus": "IN_PROGRESS",
- "totalSize": 0,
- "uploadedSize": 0,
- "downloadLink": "string",
- "quickReplies": [
- {
- "$_type": "QuickReply",
- "text": "string"
}
]
}
$_type | string Default: "FilePostMessageData" Value: "FilePostMessageData" |
type | string (EPostMessageType) Enum: "TEXT" "FILE" "CARD" "LIST" "MULTICHOICE_QUESTION" "RATING_QUESTION" "TEXT_QUESTION" "REPLY" enum-descriptions: ["TEXT: See `TextPostMessageData`","FILE: See `FilePostMessageData`","CARD: See `CardPostMessageData`","LIST: See `ListPostMessageData`","MULTICHOICE_QUESTION: See `MultichoiceQuestionPostMessageData`","RATING_QUESTION: See `RatingQuestionPostMessageData`","TEXT_QUESTION: See `TextQuestionPostMessageData`","REPLY: See `ReplyPostMessageData`"] Type of a message which is send to the collaboration server |
fallbackText | string Optional fallback text which is used when:
The value must not contain markdown. If no fallback is given, a fallback text based on the content of the message is generated. This may however not always be a perfect textual representation of the message. |
fileName | string The name of the file that is send |
caption | string A caption for the file that is send. Can be omitted |
captionType | string (EConversationMessageTextType) Enum: "SIMPLE_TEXT" "MARKDOWN" enum-descriptions: ["SIMPLE_TEXT: Text will be interpreted as simple text. <p> Auto link detection will still be possible.","MARKDOWN: Text will be interpreted as Markdown. <p> The supported Markdown subset depends on the message type."] How text in a conversation message should be interpreted. |
fileData | string The the content of the file as data URL scheme (RFC2397 - |
Array of objects (QuickReply) [ items ] Optional list of quick replies available to the message's recipients Max number of quick replies is 13. |
{- "$_type": "FilePostMessageData",
- "type": "TEXT",
- "fallbackText": "string",
- "fileName": "string",
- "caption": "string",
- "captionType": "SIMPLE_TEXT",
- "fileData": "string",
- "quickReplies": [
- {
- "$_type": "QuickReply",
- "text": "string"
}
]
}
$_type | string Default: "FirstNamePersonSearchFilter" Value: "FirstNamePersonSearchFilter" |
field | string (EPersonSearchFilterField) Enum: "PERSON_SOURCE" "SOURCE_ID" "SOURCE_DATA" "FIRST_NAME" "LAST_NAME" "USERNAME" "NICKNAME" "PERSON_TYPE" "AUTHORIZATION_ROLE" "EMAIL" "PHONE" "TEAM_ID" enum-descriptions: ["PERSON_SOURCE: Filter by the 'personSource' attribute","SOURCE_ID: Filter by the 'sourceId' attribute","SOURCE_DATA: Filter by the 'sourceData' attribute","FIRST_NAME: Filter by the 'firstName' attribute","LAST_NAME: Filter by the 'lastName' attribute","USERNAME: Filter by the 'username' attribute","NICKNAME: Filter by the 'nickname' attribute","PERSON_TYPE: Filter by the 'personType' attribute","AUTHORIZATION_ROLE: Filter by the 'authorizationRole' attribute","EMAIL: Filter by the 'email' attribute","PHONE: Filter by the 'phone' attribute","TEAM_ID: Filter by the 'teamId' attribute"] |
any (StringOperator) |
{- "$_type": "FirstNamePersonSearchFilter",
- "field": "PERSON_SOURCE",
- "operator": {
- "$_type": "EqualsStringOperator",
- "type": "EQUALS",
- "value": "string"
}
}
$_type | string Default: "FirstNameUserSearchFilter" Value: "FirstNameUserSearchFilter" |
field | string (EUserSearchFilterField) Enum: "FIRST_NAME" "LAST_NAME" "USERNAME" "TEAM_ID" "EMAIL" "AUTHORIZATION_ROLE" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" "VIRTUAL_USER" enum-descriptions: ["FIRST_NAME: Filter by the 'firstName' attribute","LAST_NAME: Filter by the 'lastName' attribute","USERNAME: Filter by the 'username' attribute","TEAM_ID: Filter by the 'teamId' attribute","EMAIL: Filter by the 'email' attribute","AUTHORIZATION_ROLE: Filter by the 'authorizationRole' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute","VIRTUAL_USER: Filter by the 'virtualUser' attribute"] |
any (StringOperator) |
{- "$_type": "FirstNameUserSearchFilter",
- "field": "FIRST_NAME",
- "operator": {
- "$_type": "EqualsStringOperator",
- "type": "EQUALS",
- "value": "string"
}
}
$_type | string Default: "GlobalData" Value: "GlobalData" |
serverIdentifier | string A unique id identifying an Unblu installation. This is read only information it will be set by the server anyway. |
object (LicenseData) Entity representing the current installed license | |
object expand-query-key: configuration type: Map The entity's configuration properties. Only contains values when the 'expand' query parameter is used with the value 'configuration'. | |
object expand-query-key: text type: Map The entity's text properties. Only contains values when the 'expand' query parameter is used with the value 'text'. | |
object expand-query-key: metadata type: Map The entity's metadata properties. Only contains values when the 'expand' query parameter is used with the value 'metadata'. |
{- "$_type": "GlobalData",
- "serverIdentifier": "string",
- "currentLicense": {
- "$_type": "LicenseData",
- "state": "NO_LICENSE",
- "licenseId": "string",
- "expirationTimestamp": 0,
- "features": {
- "property1": { },
- "property2": { }
}
}, - "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
$_type | string Default: "GreaterThanLongOperator" Value: "GreaterThanLongOperator" |
type | string (ELongOperatorType) Enum: "EQUALS" "NOT_EQUALS" "GREATER_THAN" "LOWER_THAN" "IN_RANGE" "NOT_IN_RANGE" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","GREATER_THAN: Check if the value is greater than the one provided in the operator","LOWER_THAN: Check if the value is lower than the one provided in the operator","IN_RANGE: Check if the value is in the range of the provided values. Results equal to the provided values are included.","NOT_IN_RANGE: Check if the value is NOT in the range of the provided values. Results equal to the provided values are not included."] |
value | integer <int64> |
{- "$_type": "GreaterThanLongOperator",
- "type": "EQUALS",
- "value": 0
}
$_type | string Default: "GreaterThanTimestampOperator" Value: "GreaterThanTimestampOperator" |
type | string (ETimestampOperatorType) Enum: "EQUALS" "NOT_EQUALS" "GREATER_THAN" "LOWER_THAN" "IN" "NOT_IN" "IS_NULL" "IS_NOT_NULL" "IN_RANGE" "NOT_IN_RANGE" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","GREATER_THAN: Check if the value is greater than the one provided in the operator","LOWER_THAN: Check if the value is lower than the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator","IS_NULL: Check if the value is null","IS_NOT_NULL: Check if the value is not null","IN_RANGE: Check if the value is in the range of the provided values. Results equal to the provided values are included.","NOT_IN_RANGE: Check if the value is NOT in the range of the provided values. Results equal to the provided values are not included."] |
value | integer <int64> |
{- "$_type": "GreaterThanTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
$_type | string Default: "HttpResponseCodeWebhookCallLogSearchFilter" Value: "HttpResponseCodeWebhookCallLogSearchFilter" |
field | string (EWebhookCallLogSearchFilterField) Enum: "EVENT_NAME" "REGISTRATION_ID" "REQUEST_ID" "EXECUTION_TIMESTAMP" "ENDPOINT" "RETRY_NR" "CREATION_TIMESTAMP" "HTTP_RESPONSE_CODE" enum-descriptions: ["EVENT_NAME: Filter by the 'eventName' attribute","REGISTRATION_ID: Filter by the 'registrationId' attribute","REQUEST_ID: Filter by the 'requestId' attribute","EXECUTION_TIMESTAMP: Filter by the 'executionTimestamp' attribute","ENDPOINT: Filter by the 'endpoint' attribute","RETRY_NR: Filter by the 'retryNr' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","HTTP_RESPONSE_CODE: Filter by the 'httpResponseCode' attribute"] |
any (LongOperator) |
{- "$_type": "HttpResponseCodeWebhookCallLogSearchFilter",
- "field": "EVENT_NAME",
- "operator": {
- "$_type": "EqualsLongOperator",
- "type": "EQUALS",
- "value": 0
}
}
$_type | string Default: "ArrayBody" ArrayBody BodyElement ArrayBody |
Array of objects (BodyElement) [ items ] |
{- "$_type": "ArrayBody",
- "elements": [
- {
- "$_type": "BodyElement",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- {
- "$_type": "ServiceTypeBinding",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- { }
]
}
], - "name": "string",
- "documentation": "string"
}
]
}
$_type | string Default: "AllEqualIdListOperator" Value: "AllEqualIdListOperator" |
type | string (EIdListOperatorType) enum-descriptions: ["ALL_OF: Checks if all of the values are present in the value list provided by the operator.","ANY_OF: Checks if any of the values is equal to any of the values in the list provided by the operator.","ALL_EQUAL: Check if the lists are of the same length and contain same values."] Operator types corresponding to operators defined by ALL_EQUAL ALL_OF ANY_OF ALL_EQUAL |
values | Array of strings |
{- "$_type": "AllEqualIdListOperator",
- "type": "ALL_EQUAL",
- "values": [
- "string"
]
}
$_type | string Default: "EqualsIdOperator" Value: "EqualsIdOperator" |
type | string (EIdOperatorType) enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator","IS_NULL: Check if the value is null","IS_NOT_NULL: Check if the value is not null"] Operator types corresponding to operators defined by EQUALS EQUALS NOT_EQUALS IN NOT_IN IS_NULL IS_NOT_NULL |
value | string |
{- "$_type": "EqualsIdOperator",
- "type": "EQUALS",
- "value": "string"
}
$_type | string Default: "InAuthorizationRoleOperator" Value: "InAuthorizationRoleOperator" |
type | string (EAuthorizationRoleOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator"] |
values | Array of strings (EAuthorizationRole) Items Enum: "SUPER_ADMIN" "PARTNER" "TECHNICAL_ADMIN" "ADMIN" "SUPERVISOR" "REGISTERED_USER" "WEBUSER" "ANONYMOUS_USER" |
{- "$_type": "InAuthorizationRoleOperator",
- "type": "EQUALS",
- "values": [
- "SUPER_ADMIN"
]
}
$_type | string Default: "InConversationEndReasonOperator" Value: "InConversationEndReasonOperator" |
type | string (EConversationEndReasonOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator"] |
values | Array of strings (EConversationEndReason) Items Enum: "ENDED_BY_PARTICIPANT" "MANDATORY_PARTICIPANT_GONE" "EXTERNAL_CHANNEL_CLOSED" "SOLVED_BY_BOT" "OTHER" |
{- "$_type": "InConversationEndReasonOperator",
- "type": "EQUALS",
- "values": [
- "ENDED_BY_PARTICIPANT"
]
}
$_type | string Default: "InConversationRecipientTypeOperator" Value: "InConversationRecipientTypeOperator" |
type | string (EConversationRecipientTypeOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator"] |
values | Array of strings (EConversationRecipientType) Items Enum: "AGENT" "TEAM" "NAMED_AREA" "ACCOUNT" |
{- "$_type": "InConversationRecipientTypeOperator",
- "type": "EQUALS",
- "values": [
- "AGENT"
]
}
$_type | string Default: "InConversationStateOperator" Value: "InConversationStateOperator" |
type | string (EConversationStateOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator"] |
values | Array of strings (EConversationState) Items Enum: "CREATED" "ONBOARDING" "REBOARDING" "QUEUED" "ACTIVE" "UNASSIGNED" "OFFBOARDING" "ENDED" |
{- "$_type": "InConversationStateOperator",
- "type": "EQUALS",
- "values": [
- "CREATED"
]
}
$_type | string Default: "InIdOperator" Value: "InIdOperator" |
type | string (EIdOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" "IS_NULL" "IS_NOT_NULL" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator","IS_NULL: Check if the value is null","IS_NOT_NULL: Check if the value is not null"] Operator types corresponding to operators defined by |
values | Array of strings |
{- "$_type": "InIdOperator",
- "type": "EQUALS",
- "values": [
- "string"
]
}
$_type | string Default: "InInitialEngagementTypeOperator" Value: "InInitialEngagementTypeOperator" |
type | string (EInitialEngagementTypeOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator"] |
values | Array of strings (EInitialEngagementType) Items Enum: "CHAT_REQUEST" "OFFLINE_CHAT_REQUEST" "VIDEO_REQUEST" "AUDIO_REQUEST" "HEADLESS_BROWSER_REQUEST" "DOMCAP_BROWSER_REQUEST" "MOBILE_COBROWSING_REQUEST" "SCREEN_SHARING_REQUEST" "VISITOR_COBROWSING" "HEADLESS_PIN" "DOMCAP_PIN" "MOBILE_PIN" "SCREEN_SHARING_PIN" "CHAT_INVITE" "HEADLESS_INVITE" "SCREEN_SHARING_INVITE" |
{- "$_type": "InInitialEngagementTypeOperator",
- "type": "EQUALS",
- "values": [
- "CHAT_REQUEST"
]
}
$_type | string Default: "InInvitationCreatorTypeOperator" Value: "InInvitationCreatorTypeOperator" |
type | string (EInvitationCreatorTypeOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator"] |
values | Array of strings (EInvitationCreatorType) Items Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR" |
{- "$_type": "InInvitationCreatorTypeOperator",
- "type": "EQUALS",
- "values": [
- "WEB_API"
]
}
$_type | string Default: "InInvitationTargetTypeOperator" Value: "InInvitationTargetTypeOperator" |
type | string (EInvitationTargetTypeOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator"] |
values | Array of strings (EInvitationTargetType) Items Enum: "ANONYMOUS" "VISITOR" "AGENT" "TEAM" "NAMED_AREA" "ACCOUNT" |
{- "$_type": "InInvitationTargetTypeOperator",
- "type": "EQUALS",
- "values": [
- "ANONYMOUS"
]
}
$_type | string Default: "InInvitationTypeOperator" Value: "InInvitationTypeOperator" |
type | string (EInvitationTypeOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator"] |
values | Array of strings (EInvitationType) Items Enum: "CONVERSATION_REQUEST" "AGENT_FORWARDING" "AGENT_INVITATION" "VISITOR_INVITATION" "PIN_CONVERSATION" |
{- "$_type": "InInvitationTypeOperator",
- "type": "EQUALS",
- "values": [
- "CONVERSATION_REQUEST"
]
}
$_type | string Default: "InPersonSourceOperator" Value: "InPersonSourceOperator" |
type | string (EPersonSourceOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator"] |
values | Array of strings (EPersonSource) Items Enum: "USER_DB" "VIRTUAL" |
{- "$_type": "InPersonSourceOperator",
- "type": "EQUALS",
- "values": [
- "USER_DB"
]
}
$_type | string Default: "InPersonTypeOperator" Value: "InPersonTypeOperator" |
type | string (EPersonTypeOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator"] |
values | Array of strings (EPersonType) Items Enum: "AGENT" "VISITOR" "SYSTEM" "BOT" |
{- "$_type": "InPersonTypeOperator",
- "type": "EQUALS",
- "values": [
- "AGENT"
]
}
$_type | string Default: "InRangeLongOperator" Value: "InRangeLongOperator" |
type | string (ELongOperatorType) Enum: "EQUALS" "NOT_EQUALS" "GREATER_THAN" "LOWER_THAN" "IN_RANGE" "NOT_IN_RANGE" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","GREATER_THAN: Check if the value is greater than the one provided in the operator","LOWER_THAN: Check if the value is lower than the one provided in the operator","IN_RANGE: Check if the value is in the range of the provided values. Results equal to the provided values are included.","NOT_IN_RANGE: Check if the value is NOT in the range of the provided values. Results equal to the provided values are not included."] |
minimum | integer <int64> |
maximum | integer <int64> |
{- "$_type": "InRangeLongOperator",
- "type": "EQUALS",
- "minimum": 0,
- "maximum": 0
}
$_type | string Default: "InRangeTimestampOperator" Value: "InRangeTimestampOperator" |
type | string (ETimestampOperatorType) Enum: "EQUALS" "NOT_EQUALS" "GREATER_THAN" "LOWER_THAN" "IN" "NOT_IN" "IS_NULL" "IS_NOT_NULL" "IN_RANGE" "NOT_IN_RANGE" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","GREATER_THAN: Check if the value is greater than the one provided in the operator","LOWER_THAN: Check if the value is lower than the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator","IS_NULL: Check if the value is null","IS_NOT_NULL: Check if the value is not null","IN_RANGE: Check if the value is in the range of the provided values. Results equal to the provided values are included.","NOT_IN_RANGE: Check if the value is NOT in the range of the provided values. Results equal to the provided values are not included."] |
minimum | integer <int64> |
maximum | integer <int64> |
{- "$_type": "InRangeTimestampOperator",
- "type": "EQUALS",
- "minimum": 0,
- "maximum": 0
}
$_type | string Default: "InStringOperator" Value: "InStringOperator" |
type | string (EStringOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" "IS_NULL" "IS_NOT_NULL" "CONTAINS" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator","IS_NULL: Check if the value is null","IS_NOT_NULL: Check if the value is not null","CONTAINS: Check if the value contains the string provided in the operator"] |
values | Array of strings |
{- "$_type": "InStringOperator",
- "type": "EQUALS",
- "values": [
- "string"
]
}
$_type | string Default: "InTimestampOperator" Value: "InTimestampOperator" |
type | string (ETimestampOperatorType) Enum: "EQUALS" "NOT_EQUALS" "GREATER_THAN" "LOWER_THAN" "IN" "NOT_IN" "IS_NULL" "IS_NOT_NULL" "IN_RANGE" "NOT_IN_RANGE" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","GREATER_THAN: Check if the value is greater than the one provided in the operator","LOWER_THAN: Check if the value is lower than the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator","IS_NULL: Check if the value is null","IS_NOT_NULL: Check if the value is not null","IN_RANGE: Check if the value is in the range of the provided values. Results equal to the provided values are included.","NOT_IN_RANGE: Check if the value is NOT in the range of the provided values. Results equal to the provided values are not included."] |
values | Array of integers <int64> [ items <int64 > ] |
{- "$_type": "InTimestampOperator",
- "type": "EQUALS",
- "values": [
- 0
]
}
$_type | string Default: "IncomingCallPushNotificationEvent" Value: "IncomingCallPushNotificationEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
object (PersonData) Representation of a Person (Agent or Visitor). | |
locale | string Locale (as BCP 47 language tag form including region if available) |
conversationId | string Id of the conversation |
deviceTokens | Array of strings List of device tokens |
callState | string (ECallState) Enum: "IDLE" "CALLING" "FORWARDING" "ACTIVE" enum-descriptions: ["IDLE: The call is not active (anymore)","CALLING: The call is ringing, nobody accepted it yet","FORWARDING: The call is ringing for the hidden agents of the conversation, after no visible agent has accepted the call","ACTIVE: The call is active"] State of the call |
callType | string (ECallType) Enum: "AUDIO" "VIDEO" enum-descriptions: ["AUDIO: The call was started as voice call","VIDEO: The call was started as video call"] Type of the call |
callStartTimestamp | integer <int64> Timestamp when the call started |
callerName | string Name of the person calling |
callerPersonId | string Person id of the person calling |
{- "$_type": "IncomingCallPushNotificationEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "recipient": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "locale": "string",
- "conversationId": "string",
- "deviceTokens": [
- "string"
], - "callState": "IDLE",
- "callType": "AUDIO",
- "callStartTimestamp": 0,
- "callerName": "string",
- "callerPersonId": "string"
}
$_type | string Default: "InitialEngagementTypeConversationSearchFilter" Value: "InitialEngagementTypeConversationSearchFilter" |
field | string (EConversationSearchFilterField) Enum: "CREATION_TIMESTAMP" "END_TIMESTAMP" "INITIAL_ENGAGEMENT_TYPE" "TOPIC" "CONTEXT_PERSON_ID" "ASSIGNEE_PERSON_ID" "PARTICIPANT_PERSON_ID" "STATE" "END_REASON" "CONVERSATION_TEMPLATE_ID" "RECIPIENT_ID" "RECIPIENT_TYPE" "TOKBOX_SESSION_ID" enum-descriptions: ["CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","END_TIMESTAMP: Filter by the 'endTimestamp' attribute","INITIAL_ENGAGEMENT_TYPE: Filter by the 'initialEngagementType' attribute","TOPIC: Filter by the 'topic' attribute","CONTEXT_PERSON_ID: Filter by the 'contextPersonId' attribute","ASSIGNEE_PERSON_ID: Filter by the 'assigneePersonId' attribute","PARTICIPANT_PERSON_ID: Filter by the 'personId' of the participants","STATE: Filter by the 'state' attribute","END_REASON: Filter by the 'endReason' attribute","CONVERSATION_TEMPLATE_ID: Filter by the 'conversationTemplateId' attribute","RECIPIENT_ID: Filter by the 'id' of the 'recipient' attribute","RECIPIENT_TYPE: Filter by the 'type' of the 'recipient' attribute","TOKBOX_SESSION_ID: Filter by the 'tokboxSessionId' attribute"] |
any (InitialEngagementTypeOperator) |
{- "$_type": "InitialEngagementTypeConversationSearchFilter",
- "field": "CREATION_TIMESTAMP",
- "operator": {
- "$_type": "EqualsInitialEngagementTypeOperator",
- "type": "EQUALS",
- "value": "CHAT_REQUEST"
}
}
$_type | string Default: "InitialEngagementTypeConversationTemplateSearchFilter" Value: "InitialEngagementTypeConversationTemplateSearchFilter" |
field | string (EConversationTemplateSearchFilterField) Enum: "NAME" "DESCRIPTION" "DEFAULT_TEMPLATE" "INITIAL_ENGAGEMENT_TYPE" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["NAME: Filter by the 'name' attribute","DESCRIPTION: Filter by the 'description' attribute","DEFAULT_TEMPLATE: Filter by the 'defaultTemplate' attribute","INITIAL_ENGAGEMENT_TYPE: Filter by the 'initialEngagementType' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] |
any (InitialEngagementTypeOperator) |
{- "$_type": "InitialEngagementTypeConversationTemplateSearchFilter",
- "field": "NAME",
- "operator": {
- "$_type": "EqualsInitialEngagementTypeOperator",
- "type": "EQUALS",
- "value": "CHAT_REQUEST"
}
}
$_type | string Default: "EqualsInitialEngagementTypeOperator" Value: "EqualsInitialEngagementTypeOperator" |
type | string (EInitialEngagementTypeOperatorType) enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator"] EQUALS EQUALS NOT_EQUALS IN NOT_IN |
value | string (EInitialEngagementType) Enum: "CHAT_REQUEST" "OFFLINE_CHAT_REQUEST" "VIDEO_REQUEST" "AUDIO_REQUEST" "HEADLESS_BROWSER_REQUEST" "DOMCAP_BROWSER_REQUEST" "MOBILE_COBROWSING_REQUEST" "SCREEN_SHARING_REQUEST" "VISITOR_COBROWSING" "HEADLESS_PIN" "DOMCAP_PIN" "MOBILE_PIN" "SCREEN_SHARING_PIN" "CHAT_INVITE" "HEADLESS_INVITE" "SCREEN_SHARING_INVITE" enum-descriptions: ["CHAT_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming chat conversation.","OFFLINE_CHAT_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming chat conversation while all agents are offline.","VIDEO_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming video conversation.","AUDIO_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming audio conversation.","HEADLESS_BROWSER_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming universal co-browsing conversation.","DOMCAP_BROWSER_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming embedded co-browsing conversation.","MOBILE_COBROWSING_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming mobile co-browsing conversation.","SCREEN_SHARING_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming screen sharing conversation.","VISITOR_COBROWSING: (Api initiated, visitor centered) A visitor creates a conversation via API which is not added to the queue and where he can invite other visitor to do embedded","HEADLESS_PIN: (Agent initiated, visitor centered) An agent creates a conversation with a PIN invitation for the visitor to join an universal co-browsing conversation.","DOMCAP_PIN: (Agent initiated, visitor centered) An agent creates a conversation with a PIN invitation for the visitor to join an embedded co-browsing conversation.","MOBILE_PIN: (Agent initiated, visitor centered) An agent creates a conversation with a PIN invitation for the visitor to join a mobile co-browsing conversation.","SCREEN_SHARING_PIN: (Agent initiated, visitor centered) An agent creates a conversation with a PIN invitation for the visitor to join a screen sharing conversation.","CHAT_INVITE: (Agent initiated, agent centered) An agent creates a chat conversation (this is the recommended initial engagement type for conversation created with the Web API).","HEADLESS_INVITE: (Agent initiated, agent centered) An agent creates universal co-browsing conversation and invites customer later.","SCREEN_SHARING_INVITE: (Agent initiated, agent centered) An agent creates screen sharing conversation and invites customer later."] The initial type of a conversation. The type used at creation time of the conversation determines the conversation template that is used. |
{- "$_type": "EqualsInitialEngagementTypeOperator",
- "type": "EQUALS",
- "value": "CHAT_REQUEST"
}
$_type | string Default: "EqualsInvitationCreatorTypeOperator" Value: "EqualsInvitationCreatorTypeOperator" |
type | string (EInvitationCreatorTypeOperatorType) enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator"] EQUALS EQUALS NOT_EQUALS IN NOT_IN |
value | string (EInvitationCreatorType) Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR" enum-descriptions: ["WEB_API: Invitation created with the API","SYSTEM: Invitation created by the system","AGENT: Invitation created by an agent","VISITOR: Invitation created by a visitor"] The type of the person/system who created an invitation |
{- "$_type": "EqualsInvitationCreatorTypeOperator",
- "type": "EQUALS",
- "value": "WEB_API"
}
$_type | string Default: "EqualsInvitationTargetTypeOperator" Value: "EqualsInvitationTargetTypeOperator" |
type | string (EInvitationTargetTypeOperatorType) enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator"] EQUALS EQUALS NOT_EQUALS IN NOT_IN |
value | string (EInvitationTargetType) Enum: "ANONYMOUS" "VISITOR" "AGENT" "TEAM" "NAMED_AREA" "ACCOUNT" enum-descriptions: ["ANONYMOUS","VISITOR","AGENT","TEAM","NAMED_AREA","ACCOUNT"] |
{- "$_type": "EqualsInvitationTargetTypeOperator",
- "type": "EQUALS",
- "value": "ANONYMOUS"
}
$_type | string Default: "InvitationTypeConversationInvitationSearchFilter" Value: "InvitationTypeConversationInvitationSearchFilter" |
field | string (EConversationInvitationSearchFilterField) Enum: "INVITATION_TYPE" "TARGET_TYPE" "CONVERSATION_ID" "TARGET_ID" "EXPIRATION_TIMESTAMP" "CREATION_TIMESTAMP" "CREATOR_TYPE" "CREATOR_PERSON_ID" "REDEEMING_PERSON_ID" enum-descriptions: ["INVITATION_TYPE: Filter by the 'type' attribute","TARGET_TYPE: Filter by the 'targetType' attribute","CONVERSATION_ID: Filter by the 'conversationId' attribute","TARGET_ID: Filter by the 'targetId' attribute","EXPIRATION_TIMESTAMP: Filter by the 'expirationTimestamp' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","CREATOR_TYPE: Filter by the 'creatorType' attribute","CREATOR_PERSON_ID: Filter by the 'creatorId' attribute","REDEEMING_PERSON_ID: Filter by the 'redeemerPersonId' attribute"] |
any (InvitationTypeOperator) |
{- "$_type": "InvitationTypeConversationInvitationSearchFilter",
- "field": "INVITATION_TYPE",
- "operator": {
- "$_type": "EqualsInvitationTypeOperator",
- "type": "EQUALS",
- "value": "CONVERSATION_REQUEST"
}
}
$_type | string Default: "EqualsInvitationTypeOperator" Value: "EqualsInvitationTypeOperator" |
type | string (EInvitationTypeOperatorType) enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator"] EQUALS EQUALS NOT_EQUALS IN NOT_IN |
value | string (EInvitationType) Enum: "CONVERSATION_REQUEST" "AGENT_FORWARDING" "AGENT_INVITATION" "VISITOR_INVITATION" "PIN_CONVERSATION" enum-descriptions: ["CONVERSATION_REQUEST: All visitor conversation requests e.g. Voice / Video-Call, Co-Browsing Request, etc.","AGENT_FORWARDING: Conversation forwarding to an other agent, directly or via a team. <ul> <li>The forwarding agent will leave the conversation once it has been accepted.</li> <li>The assignee will change to the forwarded agent once it has been accepted.</li> </ul>","AGENT_INVITATION: Invites an other agent into the conversation, directly or via a team. <ul> <li>The inviting agent stays in the conversation.</li> <li>The assignee will NOT change when the invited agent accepts the invitation.</li> </ul>","VISITOR_INVITATION: Anonymous Visitor invitation <ul> <li>Anyone with the invitations ticket (and the accounts API key) may enter the conversation as a Visitor.</li> <li>Once the invitation has been redeemed it can not be reused by other Visitors.</li> </ul>","PIN_CONVERSATION: Universal / Embedded / Mobile PIN Session. <ul> <li>The conversation doesn't really start until the invitation is redeemed.</li> <li>Anyone with the invitations ticket (and the accounts API key) may enter the conversation as a Visitor.</li> <li>Once the ticket has been redeemed it can not be reused by other Visitors.</li> </ul>"] |
{- "$_type": "EqualsInvitationTypeOperator",
- "type": "EQUALS",
- "value": "CONVERSATION_REQUEST"
}
conversationId | string Conversation id. |
agentPersonId | string Person ID of the agent. |
comment | string Invitation comment that will be displayed to the invited agent. Optional. |
{- "conversationId": "string",
- "agentPersonId": "string",
- "comment": "string"
}
conversationId | string Conversation id. |
teamId | string Team id. |
comment | string Invitation comment. Optional. |
{- "conversationId": "string",
- "teamId": "string",
- "comment": "string"
}
conversationId | string Conversation id. |
agentPersonId | string Person ID of the invited agent. |
comment | string Invitation comment. Optional. |
{- "conversationId": "string",
- "agentPersonId": "string",
- "comment": "string"
}
conversationId | string Conversation id. |
string Email address that will be applied to the visitor who accepts the invitation if they are anonymous and haven't provided an email address. Optional. | |
nickname | string Nickname that will be applied to the visitor who accepts the invitation if they are anonymous and don't already have a nickname set. Optional. |
{- "conversationId": "string",
- "email": "string",
- "nickname": "string"
}
conversationId | string Conversation id. |
nickname | string Nickname that will be applied to the visitor who accepts the invitation if they are anonymous and don't already have a nickname set. Optional. |
{- "conversationId": "string",
- "nickname": "string"
}
conversationId | string Conversation id. |
nickname | string Nickname that will be applied to the visitor who accepts the invitation if they are anonymous and don't already have a nickname set. Optional. |
{- "conversationId": "string",
- "nickname": "string"
}
conversationId | string Conversation id. |
teamId | string Team id. |
comment | string Invitation comment. Optional. |
{- "conversationId": "string",
- "teamId": "string",
- "comment": "string"
}
conversationId | string Conversation id. |
agentRemovalType | string (EAgentRemovalType) Enum: "KEEP_AGENTS" "REMOVE_ASSIGNED_AGENT" "REMOVE_ALL_AGENTS" enum-descriptions: ["KEEP_AGENTS","REMOVE_ASSIGNED_AGENT","REMOVE_ALL_AGENTS"] |
{- "conversationId": "string",
- "agentRemovalType": "KEEP_AGENTS"
}
$_type | string Default: "IsNotNullBooleanOperator" Value: "IsNotNullBooleanOperator" |
type | string (EBooleanOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IS_NULL" "IS_NOT_NULL" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IS_NULL: Check if the value is null","IS_NOT_NULL: Check if the value is not null"] |
{- "$_type": "IsNotNullBooleanOperator",
- "type": "EQUALS"
}
$_type | string Default: "IsNotNullIdOperator" Value: "IsNotNullIdOperator" |
type | string (EIdOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" "IS_NULL" "IS_NOT_NULL" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator","IS_NULL: Check if the value is null","IS_NOT_NULL: Check if the value is not null"] Operator types corresponding to operators defined by |
{- "$_type": "IsNotNullIdOperator",
- "type": "EQUALS"
}
$_type | string Default: "IsNotNullStringOperator" Value: "IsNotNullStringOperator" |
type | string (EStringOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" "IS_NULL" "IS_NOT_NULL" "CONTAINS" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator","IS_NULL: Check if the value is null","IS_NOT_NULL: Check if the value is not null","CONTAINS: Check if the value contains the string provided in the operator"] |
{- "$_type": "IsNotNullStringOperator",
- "type": "EQUALS"
}
$_type | string Default: "IsNotNullTimestampOperator" Value: "IsNotNullTimestampOperator" |
type | string (ETimestampOperatorType) Enum: "EQUALS" "NOT_EQUALS" "GREATER_THAN" "LOWER_THAN" "IN" "NOT_IN" "IS_NULL" "IS_NOT_NULL" "IN_RANGE" "NOT_IN_RANGE" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","GREATER_THAN: Check if the value is greater than the one provided in the operator","LOWER_THAN: Check if the value is lower than the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator","IS_NULL: Check if the value is null","IS_NOT_NULL: Check if the value is not null","IN_RANGE: Check if the value is in the range of the provided values. Results equal to the provided values are included.","NOT_IN_RANGE: Check if the value is NOT in the range of the provided values. Results equal to the provided values are not included."] |
{- "$_type": "IsNotNullTimestampOperator",
- "type": "EQUALS"
}
$_type | string Default: "IsNullBooleanOperator" Value: "IsNullBooleanOperator" |
type | string (EBooleanOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IS_NULL" "IS_NOT_NULL" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IS_NULL: Check if the value is null","IS_NOT_NULL: Check if the value is not null"] |
{- "$_type": "IsNullBooleanOperator",
- "type": "EQUALS"
}
$_type | string Default: "IsNullIdOperator" Value: "IsNullIdOperator" |
type | string (EIdOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" "IS_NULL" "IS_NOT_NULL" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator","IS_NULL: Check if the value is null","IS_NOT_NULL: Check if the value is not null"] Operator types corresponding to operators defined by |
{- "$_type": "IsNullIdOperator",
- "type": "EQUALS"
}
$_type | string Default: "IsNullStringOperator" Value: "IsNullStringOperator" |
type | string (EStringOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" "IS_NULL" "IS_NOT_NULL" "CONTAINS" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator","IS_NULL: Check if the value is null","IS_NOT_NULL: Check if the value is not null","CONTAINS: Check if the value contains the string provided in the operator"] |
{- "$_type": "IsNullStringOperator",
- "type": "EQUALS"
}
$_type | string Default: "IsNullTimestampOperator" Value: "IsNullTimestampOperator" |
type | string (ETimestampOperatorType) Enum: "EQUALS" "NOT_EQUALS" "GREATER_THAN" "LOWER_THAN" "IN" "NOT_IN" "IS_NULL" "IS_NOT_NULL" "IN_RANGE" "NOT_IN_RANGE" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","GREATER_THAN: Check if the value is greater than the one provided in the operator","LOWER_THAN: Check if the value is lower than the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator","IS_NULL: Check if the value is null","IS_NOT_NULL: Check if the value is not null","IN_RANGE: Check if the value is in the range of the provided values. Results equal to the provided values are included.","NOT_IN_RANGE: Check if the value is NOT in the range of the provided values. Results equal to the provided values are not included."] |
{- "$_type": "IsNullTimestampOperator",
- "type": "EQUALS"
}
$_type | string Default: "JoinedTimestampPersonPresenceSearchFilter" Value: "JoinedTimestampPersonPresenceSearchFilter" |
field | string (EPersonPresenceSearchFilterField) Enum: "JOINED_TIMESTAMP" "LEFT_TIMESTAMP" "PERSON_ID" enum-descriptions: ["JOINED_TIMESTAMP: Filter by the 'joindTimestamp' attribute","LEFT_TIMESTAMP: Filter by the 'leftTimestamp' attribute","PERSON_ID: Filter by the 'personId' attribute"] |
any (TimestampOperator) |
{- "$_type": "JoinedTimestampPersonPresenceSearchFilter",
- "field": "JOINED_TIMESTAMP",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
$_type | string Default: "KeyCannedResponseSearchFilter" Value: "KeyCannedResponseSearchFilter" |
field | string (ECannedResponseSearchFilterField) Enum: "KEY" "TITLE" "TEXT" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["KEY: Filter by the 'key' attribute","TITLE: Filter by the 'title' attribute","TEXT: Filter by the 'text' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] |
any (StringOperator) |
{- "$_type": "KeyCannedResponseSearchFilter",
- "field": "KEY",
- "operator": {
- "$_type": "EqualsStringOperator",
- "type": "EQUALS",
- "value": "string"
}
}
$_type | string Default: "LastNamePersonSearchFilter" Value: "LastNamePersonSearchFilter" |
field | string (EPersonSearchFilterField) Enum: "PERSON_SOURCE" "SOURCE_ID" "SOURCE_DATA" "FIRST_NAME" "LAST_NAME" "USERNAME" "NICKNAME" "PERSON_TYPE" "AUTHORIZATION_ROLE" "EMAIL" "PHONE" "TEAM_ID" enum-descriptions: ["PERSON_SOURCE: Filter by the 'personSource' attribute","SOURCE_ID: Filter by the 'sourceId' attribute","SOURCE_DATA: Filter by the 'sourceData' attribute","FIRST_NAME: Filter by the 'firstName' attribute","LAST_NAME: Filter by the 'lastName' attribute","USERNAME: Filter by the 'username' attribute","NICKNAME: Filter by the 'nickname' attribute","PERSON_TYPE: Filter by the 'personType' attribute","AUTHORIZATION_ROLE: Filter by the 'authorizationRole' attribute","EMAIL: Filter by the 'email' attribute","PHONE: Filter by the 'phone' attribute","TEAM_ID: Filter by the 'teamId' attribute"] |
any (StringOperator) |
{- "$_type": "LastNamePersonSearchFilter",
- "field": "PERSON_SOURCE",
- "operator": {
- "$_type": "EqualsStringOperator",
- "type": "EQUALS",
- "value": "string"
}
}
$_type | string Default: "LastNameUserSearchFilter" Value: "LastNameUserSearchFilter" |
field | string (EUserSearchFilterField) Enum: "FIRST_NAME" "LAST_NAME" "USERNAME" "TEAM_ID" "EMAIL" "AUTHORIZATION_ROLE" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" "VIRTUAL_USER" enum-descriptions: ["FIRST_NAME: Filter by the 'firstName' attribute","LAST_NAME: Filter by the 'lastName' attribute","USERNAME: Filter by the 'username' attribute","TEAM_ID: Filter by the 'teamId' attribute","EMAIL: Filter by the 'email' attribute","AUTHORIZATION_ROLE: Filter by the 'authorizationRole' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute","VIRTUAL_USER: Filter by the 'virtualUser' attribute"] |
any (StringOperator) |
{- "$_type": "LastNameUserSearchFilter",
- "field": "FIRST_NAME",
- "operator": {
- "$_type": "EqualsStringOperator",
- "type": "EQUALS",
- "value": "string"
}
}
$_type | string Default: "LeftTimestampPersonPresenceSearchFilter" Value: "LeftTimestampPersonPresenceSearchFilter" |
field | string (EPersonPresenceSearchFilterField) Enum: "JOINED_TIMESTAMP" "LEFT_TIMESTAMP" "PERSON_ID" enum-descriptions: ["JOINED_TIMESTAMP: Filter by the 'joindTimestamp' attribute","LEFT_TIMESTAMP: Filter by the 'leftTimestamp' attribute","PERSON_ID: Filter by the 'personId' attribute"] |
any (TimestampOperator) |
{- "$_type": "LeftTimestampPersonPresenceSearchFilter",
- "field": "JOINED_TIMESTAMP",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
$_type | string Default: "LicenseData" Value: "LicenseData" |
state | string (ELicenseState) Enum: "NO_LICENSE" "ACTIVE" "INVALID" "INCOMPATIBLE" "EXPIRED" enum-descriptions: ["NO_LICENSE: No license installed. All licensed features can not be used.","ACTIVE: Valid license installed, this default state to use Unblu.","INVALID: Invalid license installed. All licensed features can not be used.","INCOMPATIBLE: The license type of the installed license is not compatible with this server. All licensed features can not be used.","EXPIRED: Valid license installed, but with an expiration date in the past. All licensed features can not be used."] State of the global server license |
licenseId | string Id of the current license. Is null when no license is installed. This is read only information that will changed when a new license is installed. |
expirationTimestamp | integer <int64> utc timestamp when the current license will expires. Is null when no license is installed. This is read only information that will changed when a new license is installed. |
object features contained in the license. |
{- "$_type": "LicenseData",
- "state": "NO_LICENSE",
- "licenseId": "string",
- "expirationTimestamp": 0,
- "features": {
- "property1": { },
- "property2": { }
}
}
$_type | string Default: "ListMessageCardItem" Value: "ListMessageCardItem" |
imageUrl | string URL of the image displayed at the top of the card. |
imageAltText | string Alt text for the image. |
title | string Title displayed bold below the image. |
body | string Body text which may optionally contain markdown. |
bodyTextType | string (EConversationMessageTextType) Enum: "SIMPLE_TEXT" "MARKDOWN" enum-descriptions: ["SIMPLE_TEXT: Text will be interpreted as simple text. <p> Auto link detection will still be possible.","MARKDOWN: Text will be interpreted as Markdown. <p> The supported Markdown subset depends on the message type."] How text in a conversation message should be interpreted. |
object (MessageAction) Message action used in card and list messages. Reply actions are displayed as buttons whereas internal and external links are rendered as links. |
{- "$_type": "ListMessageCardItem",
- "imageUrl": "string",
- "imageAltText": "string",
- "title": "string",
- "body": "string",
- "bodyTextType": "SIMPLE_TEXT",
- "action": {
- "$_type": "MessageAction",
- "actionType": "LINK_INTERNAL",
- "label": "string",
- "value": "string"
}
}
$_type | string Default: "ListMessageData" Value: "ListMessageData" |
id | string The ID of the message. |
conversationId | string Conversation ID to which this message belongs to |
externalMessengerChannelId | string ID of the external messenger channel connected to the conversation. Null if the conversation is not connected to an external messenger. |
accountId | string Account ID to which this message and conversation belongs to. |
object (PersonData) Representation of a Person (Agent or Visitor). | |
senderPersonPresenceId | string Id of the person presence that sends the message. May be null if the message was sent by the system. |
serverTimestamp | integer <int64> utc timestamp when the message was received on the server. |
sendTimestamp | integer <int64> utc timestamp when the message was sent from the client |
type | string (EMessageType) Enum: "TEXT" "FILE" "CARD" "LIST" "APPROVAL_REQUEST" "MULTICHOICE_QUESTION" "RATING_QUESTION" "TEXT_QUESTION" "REPLY" "QUESTION_ABORTED" enum-descriptions: ["TEXT","FILE","CARD","LIST","APPROVAL_REQUEST","MULTICHOICE_QUESTION","RATING_QUESTION","TEXT_QUESTION","REPLY","QUESTION_ABORTED"] The message type of a conversation message |
recipientPersonIds | Array of strings Person IDs of the recipients of the message. If it is null, all active participations are recipients |
fallbackText | string Text representation of the message which is used in following cases:
The fallback text can be provided by the sender (bot, external messenger) or is generated when missing. This may however not always be a perfect textual representation of the message. |
actionId | string An ID of the action triggering the message to be able to identify a message created by an action. |
sourceId | string A custom ID which identifies where this message initially came from. |
object (MessageHeader) Header of a message which may contain an image, title and body. All of these parts are optional as long as it contains at least one of them. | |
Array of objects (ListMessageCardItem) [ items ] List of items of the list message | |
Array of objects (MessageAction) [ items ] Actions which will be displayed at the bottom of the list | |
Array of objects (QuickReply) [ items ] Optional quick replies which will be displayed above the chat input as a possible response options |
{- "$_type": "ListMessageData",
- "id": "string",
- "conversationId": "string",
- "externalMessengerChannelId": "string",
- "accountId": "string",
- "senderPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "senderPersonPresenceId": "string",
- "serverTimestamp": 0,
- "sendTimestamp": 0,
- "type": "TEXT",
- "recipientPersonIds": [
- "string"
], - "fallbackText": "string",
- "actionId": "string",
- "sourceId": "string",
- "header": {
- "$_type": "MessageHeader",
- "imageUrl": "string",
- "imageAltText": "string",
- "title": "string",
- "body": "string",
- "bodyTextType": "SIMPLE_TEXT"
}, - "items": [
- {
- "$_type": "ListMessageCardItem",
- "imageUrl": "string",
- "imageAltText": "string",
- "title": "string",
- "body": "string",
- "bodyTextType": "SIMPLE_TEXT",
- "action": {
- "$_type": "MessageAction",
- "actionType": "LINK_INTERNAL",
- "label": "string",
- "value": "string"
}
}
], - "actions": [
- {
- "$_type": "MessageAction",
- "actionType": "LINK_INTERNAL",
- "label": "string",
- "value": "string"
}
], - "quickReplies": [
- {
- "$_type": "QuickReply",
- "text": "string"
}
]
}
$_type | string Default: "ListPostMessageData" Value: "ListPostMessageData" |
type | string (EPostMessageType) Enum: "TEXT" "FILE" "CARD" "LIST" "MULTICHOICE_QUESTION" "RATING_QUESTION" "TEXT_QUESTION" "REPLY" enum-descriptions: ["TEXT: See `TextPostMessageData`","FILE: See `FilePostMessageData`","CARD: See `CardPostMessageData`","LIST: See `ListPostMessageData`","MULTICHOICE_QUESTION: See `MultichoiceQuestionPostMessageData`","RATING_QUESTION: See `RatingQuestionPostMessageData`","TEXT_QUESTION: See `TextQuestionPostMessageData`","REPLY: See `ReplyPostMessageData`"] Type of a message which is send to the collaboration server |
fallbackText | string Optional fallback text which is used when:
The value must not contain markdown. If no fallback is given, a fallback text based on the content of the message is generated. This may however not always be a perfect textual representation of the message. |
object (MessageHeader) Header of a message which may contain an image, title and body. All of these parts are optional as long as it contains at least one of them. | |
Array of objects (PostListMessageCardItemData) [ items ] List items which will be displayed below the header and above the actions. (optional) Max number of list items is 10. | |
Array of objects (MessageAction) [ items ] Actions which will be displayed at the bottom of the list. (optional) Max number of actions is 5. | |
Array of objects (QuickReply) [ items ] Optional list of quick replies available to the message's recipients Max number of quick replies is 13. |
{- "$_type": "ListPostMessageData",
- "type": "TEXT",
- "fallbackText": "string",
- "header": {
- "$_type": "MessageHeader",
- "imageUrl": "string",
- "imageAltText": "string",
- "title": "string",
- "body": "string",
- "bodyTextType": "SIMPLE_TEXT"
}, - "items": [
- {
- "$_type": "PostListMessageCardItemData",
- "imageUrl": "string",
- "imageAltText": "string",
- "title": "string",
- "body": "string",
- "bodyTextType": "SIMPLE_TEXT",
- "action": {
- "$_type": "MessageAction",
- "actionType": "LINK_INTERNAL",
- "label": "string",
- "value": "string"
}
}
], - "actions": [
- {
- "$_type": "MessageAction",
- "actionType": "LINK_INTERNAL",
- "label": "string",
- "value": "string"
}
], - "quickReplies": [
- {
- "$_type": "QuickReply",
- "text": "string"
}
]
}
$_type | string Default: "EqualsLongOperator" Value: "EqualsLongOperator" |
type | string (ELongOperatorType) enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","GREATER_THAN: Check if the value is greater than the one provided in the operator","LOWER_THAN: Check if the value is lower than the one provided in the operator","IN_RANGE: Check if the value is in the range of the provided values. Results equal to the provided values are included.","NOT_IN_RANGE: Check if the value is NOT in the range of the provided values. Results equal to the provided values are not included."] EQUALS EQUALS NOT_EQUALS GREATER_THAN LOWER_THAN IN_RANGE NOT_IN_RANGE |
value | integer <int64> |
{- "$_type": "EqualsLongOperator",
- "type": "EQUALS",
- "value": 0
}
$_type | string Default: "LowerThanLongOperator" Value: "LowerThanLongOperator" |
type | string (ELongOperatorType) Enum: "EQUALS" "NOT_EQUALS" "GREATER_THAN" "LOWER_THAN" "IN_RANGE" "NOT_IN_RANGE" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","GREATER_THAN: Check if the value is greater than the one provided in the operator","LOWER_THAN: Check if the value is lower than the one provided in the operator","IN_RANGE: Check if the value is in the range of the provided values. Results equal to the provided values are included.","NOT_IN_RANGE: Check if the value is NOT in the range of the provided values. Results equal to the provided values are not included."] |
value | integer <int64> |
{- "$_type": "LowerThanLongOperator",
- "type": "EQUALS",
- "value": 0
}
$_type | string Default: "LowerThanTimestampOperator" Value: "LowerThanTimestampOperator" |
type | string (ETimestampOperatorType) Enum: "EQUALS" "NOT_EQUALS" "GREATER_THAN" "LOWER_THAN" "IN" "NOT_IN" "IS_NULL" "IS_NOT_NULL" "IN_RANGE" "NOT_IN_RANGE" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","GREATER_THAN: Check if the value is greater than the one provided in the operator","LOWER_THAN: Check if the value is lower than the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator","IS_NULL: Check if the value is null","IS_NOT_NULL: Check if the value is not null","IN_RANGE: Check if the value is in the range of the provided values. Results equal to the provided values are included.","NOT_IN_RANGE: Check if the value is NOT in the range of the provided values. Results equal to the provided values are not included."] |
value | integer <int64> |
{- "$_type": "LowerThanTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
$_type | string Default: "MessageAction" Value: "MessageAction" |
actionType | string (EConversationMessageActionType) Enum: "LINK_INTERNAL" "LINK_EXTERNAL" "REPLY_MESSAGE" "REPLY_MESSAGE_WITH_TECHNICAL_VALUE" enum-descriptions: ["LINK_INTERNAL: An internal link that will open in the same tab as the unblu chat when clicked. <p> The action will be displayed as a link using the action's label as text.","LINK_EXTERNAL: An external link that will open in a new tab when clicked. <p> The action will be displayed as a link with an \"external\" icon using the action's label as text.","REPLY_MESSAGE: A reply message will be sent in the name of the clicking person. <p> The action will be displayed as a button with the action's label as text <p> If the action is clicked, a message of the type TextMessage will be sent in the name of the clicking person containing the action's value as the message text.","REPLY_MESSAGE_WITH_TECHNICAL_VALUE: A reply message will be sent in the name of the clicking person. <p> The action will be displayed as a button with the action's label as text <p> If the action is clicked, a message of the type ReplyMessage will be sent in the name of the clicking person. It will reference the message this action is part of as questionMessage, contain the action's value as the reply's value and the label as text visible to the user. message text."] Type of message action used in Card and List messages. |
label | string Text displayed in the action button / link Max length is 24 characters. |
value | string The URL to open if the action type is a link or the reply message if the type is |
{- "$_type": "MessageAction",
- "actionType": "LINK_INTERNAL",
- "label": "string",
- "value": "string"
}
$_type | string Default: "ApprovalRequestMessageData" Value: "ApprovalRequestMessageData" |
id | string The ID of the message. |
conversationId | string Conversation ID to which this message belongs to |
externalMessengerChannelId | string ID of the external messenger channel connected to the conversation. Null if the conversation is not connected to an external messenger. |
accountId | string Account ID to which this message and conversation belongs to. |
object (PersonData) Representation of a Person (Agent or Visitor). | |
senderPersonPresenceId | string Id of the person presence that sends the message. May be null if the message was sent by the system. |
serverTimestamp | integer <int64> utc timestamp when the message was received on the server. |
sendTimestamp | integer <int64> utc timestamp when the message was sent from the client |
type | string (EMessageType) enum-descriptions: ["TEXT","FILE","CARD","LIST","APPROVAL_REQUEST","MULTICHOICE_QUESTION","RATING_QUESTION","TEXT_QUESTION","REPLY","QUESTION_ABORTED"] The message type of a conversation message APPROVAL_REQUEST TEXT FILE CARD LIST APPROVAL_REQUEST MULTICHOICE_QUESTION RATING_QUESTION TEXT_QUESTION REPLY QUESTION_ABORTED |
recipientPersonIds | Array of strings Person IDs of the recipients of the message. If it is null, all active participations are recipients |
fallbackText | string Text representation of the message which is used in following cases:
The fallback text can be provided by the sender (bot, external messenger) or is generated when missing. This may however not always be a perfect textual representation of the message. |
actionId | string An ID of the action triggering the message to be able to identify a message created by an action. |
sourceId | string A custom ID which identifies where this message initially came from. |
text | string Text of the message |
textType | string (EConversationMessageTextType) Enum: "SIMPLE_TEXT" "MARKDOWN" enum-descriptions: ["SIMPLE_TEXT: Text will be interpreted as simple text. <p> Auto link detection will still be possible.","MARKDOWN: Text will be interpreted as Markdown. <p> The supported Markdown subset depends on the message type."] How text in a conversation message should be interpreted. |
Array of objects (MultichoiceQuestionOption) [ items ] Response options for the question. | |
answerStatus | string (EAnswerStatus) Enum: "PENDING" "ANSWERED" "TIMEDOUT" "CANCELED" enum-descriptions: ["PENDING: Question is not answered yet","ANSWERED: Question was successfully answered","TIMEDOUT: Question was running into a timeout","CANCELED: Question was canceled by the system, a bot or an external messenger channel"] The state of a question message |
{- "$_type": "ApprovalRequestMessageData",
- "id": "string",
- "conversationId": "string",
- "externalMessengerChannelId": "string",
- "accountId": "string",
- "senderPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "senderPersonPresenceId": "string",
- "serverTimestamp": 0,
- "sendTimestamp": 0,
- "type": "APPROVAL_REQUEST",
- "recipientPersonIds": [
- "string"
], - "fallbackText": "string",
- "actionId": "string",
- "sourceId": "string",
- "text": "string",
- "textType": "SIMPLE_TEXT",
- "options": [
- {
- "$_type": "MultichoiceQuestionOption",
- "label": "string",
- "value": "string",
- "primary": true
}
], - "answerStatus": "PENDING"
}
$_type | string Default: "MessageHeader" Value: "MessageHeader" |
imageUrl | string URL of the image displayed at the top of the card. |
imageAltText | string Alt text for the image. |
title | string Title displayed bold below the image. Max length is 64 characters. |
body | string Body text which may optionally contain markdown. Max length is 256 characters. |
bodyTextType | string (EConversationMessageTextType) Enum: "SIMPLE_TEXT" "MARKDOWN" enum-descriptions: ["SIMPLE_TEXT: Text will be interpreted as simple text. <p> Auto link detection will still be possible.","MARKDOWN: Text will be interpreted as Markdown. <p> The supported Markdown subset depends on the message type."] How text in a conversation message should be interpreted. |
{- "$_type": "MessageHeader",
- "imageUrl": "string",
- "imageAltText": "string",
- "title": "string",
- "body": "string",
- "bodyTextType": "SIMPLE_TEXT"
}
$_type | string Default: "MessageOrderBy" Value: "MessageOrderBy" |
field | string (EMessageOrderByField) Enum: "ID" "CONVERSATION_ID" "SEND_TIMESTAMP" "SERVER_TIMESTAMP" "SENDER_PERSON_ID" "TYPE" "TEXT" enum-descriptions: ["ID: Sort by the 'id' attribute","CONVERSATION_ID: Sort by the 'conversationId' attribute","SEND_TIMESTAMP: Sort by the 'sendTimestamp' attribute","SERVER_TIMESTAMP: Sort by the 'serverTimestamp' attribute","SENDER_PERSON_ID: Sort by the 'senderPersonId' attribute","TYPE: Sort by the 'type' attribute","TEXT: Sort by the 'text' attribute"] |
order | string (Order) Enum: "ASCENDING" "DESCENDING" enum-descriptions: ["ASCENDING: Sort in the ascending order (smallest to largest, 0 to 9, and/or A to Z)","DESCENDING: Sort in the descending order (largest to smallest, 9 to 0, and/or Z to A)"] |
{- "$_type": "MessageOrderBy",
- "field": "ID",
- "order": "ASCENDING"
}
$_type | string Default: "MessageQuery" Value: "MessageQuery" |
Array of any (MessageSearchFilter) [ items ] List of filters to narrow the search of entities | |
Array of objects (MessageOrderBy) [ items ] List of criteria to order the search result list | |
offset | integer <int32> Offset position in the result set to start pagination |
limit | integer <int32> Maximal amount of items returned |
{- "$_type": "MessageQuery",
- "searchFilters": [
- {
- "$_type": "SendTimestampMessageSearchFilter",
- "field": "SEND_TIMESTAMP",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
], - "orderBy": [
- {
- "$_type": "MessageOrderBy",
- "field": "ID",
- "order": "ASCENDING"
}
], - "offset": 0,
- "limit": 0
}
$_type | string Default: "MessageResult" Value: "MessageResult" |
hasMoreItems | boolean Flag to indicate if there are more items on the server |
nextOffset | integer <int32> If more items are present on the server, this value can be used as offset in the next query |
Array of objects (ConversationHistoryMessageData) [ items ] The returned list of entities |
{- "$_type": "MessageResult",
- "hasMoreItems": true,
- "nextOffset": 0,
- "items": [
- {
- "$_type": "ConversationHistoryMessageData",
- "id": "string",
- "conversationId": "string",
- "sendTimestamp": 0,
- "serverTimestamp": 0,
- "senderPersonId": "string",
- "type": "TEXT",
- "recipientPersonIds": [
- "string"
], - "text": "string"
}
]
}
$_type | string Default: "SendTimestampMessageSearchFilter" Value: "SendTimestampMessageSearchFilter" |
field | string (EMessageSearchFilterField) enum-descriptions: ["SEND_TIMESTAMP: Filter by the 'sendTimestamp' attribute"] SEND_TIMESTAMP SEND_TIMESTAMP |
any (TimestampOperator) |
{- "$_type": "SendTimestampMessageSearchFilter",
- "field": "SEND_TIMESTAMP",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
$_type | string Default: "MissedCallPushNotificationEvent" Value: "MissedCallPushNotificationEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
object (PersonData) Representation of a Person (Agent or Visitor). | |
locale | string Locale (as BCP 47 language tag form including region if available) |
conversationId | string Id of the conversation |
deviceTokens | Array of strings List of device tokens |
callState | string (ECallState) Enum: "IDLE" "CALLING" "FORWARDING" "ACTIVE" enum-descriptions: ["IDLE: The call is not active (anymore)","CALLING: The call is ringing, nobody accepted it yet","FORWARDING: The call is ringing for the hidden agents of the conversation, after no visible agent has accepted the call","ACTIVE: The call is active"] State of the call |
callType | string (ECallType) Enum: "AUDIO" "VIDEO" enum-descriptions: ["AUDIO: The call was started as voice call","VIDEO: The call was started as video call"] Type of the call |
callStartTimestamp | integer <int64> Timestamp when the call started |
callerName | string Name of the person calling |
callerPersonId | string Person ID of the person calling |
callEndReason | string (ECallParticipationEndReason) Enum: "MISSED_BECAUSE_TIMEOUT" "MISSED_BECAUSE_TERMINATED" "TERMINATED_BY_PARTICIPANT" enum-descriptions: ["MISSED_BECAUSE_TIMEOUT: The participation was ended because of a timeout on the participant's side.","MISSED_BECAUSE_TERMINATED: The participation ended because the initiator terminated the call before the other participant answered it.","TERMINATED_BY_PARTICIPANT: The participation ended normally"] Determines the reason why the participation on a call ended. |
{- "$_type": "MissedCallPushNotificationEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "recipient": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "locale": "string",
- "conversationId": "string",
- "deviceTokens": [
- "string"
], - "callState": "IDLE",
- "callType": "AUDIO",
- "callStartTimestamp": 0,
- "callerName": "string",
- "callerPersonId": "string",
- "callEndReason": "MISSED_BECAUSE_TIMEOUT"
}
$_type | string Default: "ModificationTimestampAccountSearchFilter" Value: "ModificationTimestampAccountSearchFilter" |
field | string (EAccountSearchFilterField) Enum: "NAME" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["NAME: Filter by the 'name' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] |
any (TimestampOperator) |
{- "$_type": "ModificationTimestampAccountSearchFilter",
- "field": "NAME",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
$_type | string Default: "ModificationTimestampAddressSearchFilter" Value: "ModificationTimestampAddressSearchFilter" |
field | string (EAddressSearchFilterField) Enum: "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] |
any (TimestampOperator) |
{- "$_type": "ModificationTimestampAddressSearchFilter",
- "field": "CREATION_TIMESTAMP",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
$_type | string Default: "ModificationTimestampApiKeySearchFilter" Value: "ModificationTimestampApiKeySearchFilter" |
field | string (EApiKeySearchFilterField) Enum: "NAME" "DESCRIPTION" "API_KEY" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["NAME: Filter by the 'name' attribute","DESCRIPTION: Filter by the 'description' attribute","API_KEY: Filter by the 'apiKey' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] |
any (TimestampOperator) |
{- "$_type": "ModificationTimestampApiKeySearchFilter",
- "field": "NAME",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
$_type | string Default: "ModificationTimestampCannedResponseSearchFilter" Value: "ModificationTimestampCannedResponseSearchFilter" |
field | string (ECannedResponseSearchFilterField) Enum: "KEY" "TITLE" "TEXT" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["KEY: Filter by the 'key' attribute","TITLE: Filter by the 'title' attribute","TEXT: Filter by the 'text' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] |
any (TimestampOperator) |
{- "$_type": "ModificationTimestampCannedResponseSearchFilter",
- "field": "KEY",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
$_type | string Default: "ModificationTimestampContactSearchFilter" Value: "ModificationTimestampContactSearchFilter" |
field | string (EContactSearchFilterField) Enum: "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] |
any (TimestampOperator) |
{- "$_type": "ModificationTimestampContactSearchFilter",
- "field": "CREATION_TIMESTAMP",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
$_type | string Default: "ModificationTimestampConversationTemplateSearchFilter" Value: "ModificationTimestampConversationTemplateSearchFilter" |
field | string (EConversationTemplateSearchFilterField) Enum: "NAME" "DESCRIPTION" "DEFAULT_TEMPLATE" "INITIAL_ENGAGEMENT_TYPE" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["NAME: Filter by the 'name' attribute","DESCRIPTION: Filter by the 'description' attribute","DEFAULT_TEMPLATE: Filter by the 'defaultTemplate' attribute","INITIAL_ENGAGEMENT_TYPE: Filter by the 'initialEngagementType' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] |
any (TimestampOperator) |
{- "$_type": "ModificationTimestampConversationTemplateSearchFilter",
- "field": "NAME",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
$_type | string Default: "ModificationTimestampDialogBotSearchFilter" Value: "ModificationTimestampDialogBotSearchFilter" |
field | string (EDialogBotSearchFilterField) Enum: "NAME" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["NAME: Filter by the 'name' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] |
any (TimestampOperator) |
{- "$_type": "ModificationTimestampDialogBotSearchFilter",
- "field": "NAME",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
$_type | string Default: "ModificationTimestampDomainSearchFilter" Value: "ModificationTimestampDomainSearchFilter" |
field | string (EDomainSearchFilterField) Enum: "DOMAIN_NAME" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["DOMAIN_NAME: Filter by the 'domainName' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] |
any (TimestampOperator) |
{- "$_type": "ModificationTimestampDomainSearchFilter",
- "field": "DOMAIN_NAME",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
$_type | string Default: "ModificationTimestampExternalMessengerChannelSearchFilter" Value: "ModificationTimestampExternalMessengerChannelSearchFilter" |
field | string (EExternalMessengerChannelSearchFilterField) Enum: "NAME" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["NAME: Filter by the 'name' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] |
any (TimestampOperator) |
{- "$_type": "ModificationTimestampExternalMessengerChannelSearchFilter",
- "field": "NAME",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
$_type | string Default: "ModificationTimestampNamedAreaSearchFilter" Value: "ModificationTimestampNamedAreaSearchFilter" |
field | string (ENamedAreaSearchFilterField) Enum: "NAME" "DESCRIPTION" "SITE_ID" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["NAME: Filter by the 'name' attribute","DESCRIPTION: Filter by the 'description' attribute","SITE_ID: Filter by the 'siteId' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] |
any (TimestampOperator) |
{- "$_type": "ModificationTimestampNamedAreaSearchFilter",
- "field": "NAME",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
$_type | string Default: "ModificationTimestampTeamSearchFilter" Value: "ModificationTimestampTeamSearchFilter" |
field | string (ETeamSearchFilterField) Enum: "NAME" "DESCRIPTION" "PARENT_ID" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["NAME: Filter by the 'name' attribute","DESCRIPTION: Filter by the 'description' attribute","PARENT_ID: Filter by the 'parentId' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] |
any (TimestampOperator) |
{- "$_type": "ModificationTimestampTeamSearchFilter",
- "field": "NAME",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
$_type | string Default: "ModificationTimestampUserSearchFilter" Value: "ModificationTimestampUserSearchFilter" |
field | string (EUserSearchFilterField) Enum: "FIRST_NAME" "LAST_NAME" "USERNAME" "TEAM_ID" "EMAIL" "AUTHORIZATION_ROLE" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" "VIRTUAL_USER" enum-descriptions: ["FIRST_NAME: Filter by the 'firstName' attribute","LAST_NAME: Filter by the 'lastName' attribute","USERNAME: Filter by the 'username' attribute","TEAM_ID: Filter by the 'teamId' attribute","EMAIL: Filter by the 'email' attribute","AUTHORIZATION_ROLE: Filter by the 'authorizationRole' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute","VIRTUAL_USER: Filter by the 'virtualUser' attribute"] |
any (TimestampOperator) |
{- "$_type": "ModificationTimestampUserSearchFilter",
- "field": "FIRST_NAME",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
$_type | string Default: "ModificationTimestampWebhookRegistrationSearchFilter" Value: "ModificationTimestampWebhookRegistrationSearchFilter" |
field | string (EWebhookRegistrationSearchFilterField) Enum: "NAME" "DESCRIPTION" "ENDPOINT" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["NAME: Sort by the 'name' attribute","DESCRIPTION: Sort by the 'description' attribute","ENDPOINT: Sort by the 'endpoint' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] |
any (TimestampOperator) |
{- "$_type": "ModificationTimestampWebhookRegistrationSearchFilter",
- "field": "NAME",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
$_type | string Default: "MultichoiceQuestionMessageData" Value: "MultichoiceQuestionMessageData" |
id | string The ID of the message. |
conversationId | string Conversation ID to which this message belongs to |
externalMessengerChannelId | string ID of the external messenger channel connected to the conversation. Null if the conversation is not connected to an external messenger. |
accountId | string Account ID to which this message and conversation belongs to. |
object (PersonData) Representation of a Person (Agent or Visitor). | |
senderPersonPresenceId | string Id of the person presence that sends the message. May be null if the message was sent by the system. |
serverTimestamp | integer <int64> utc timestamp when the message was received on the server. |
sendTimestamp | integer <int64> utc timestamp when the message was sent from the client |
type | string (EMessageType) Enum: "TEXT" "FILE" "CARD" "LIST" "APPROVAL_REQUEST" "MULTICHOICE_QUESTION" "RATING_QUESTION" "TEXT_QUESTION" "REPLY" "QUESTION_ABORTED" enum-descriptions: ["TEXT","FILE","CARD","LIST","APPROVAL_REQUEST","MULTICHOICE_QUESTION","RATING_QUESTION","TEXT_QUESTION","REPLY","QUESTION_ABORTED"] The message type of a conversation message |
recipientPersonIds | Array of strings Person IDs of the recipients of the message. If it is null, all active participations are recipients |
fallbackText | string Text representation of the message which is used in following cases:
The fallback text can be provided by the sender (bot, external messenger) or is generated when missing. This may however not always be a perfect textual representation of the message. |
actionId | string An ID of the action triggering the message to be able to identify a message created by an action. |
sourceId | string A custom ID which identifies where this message initially came from. |
text | string Text of the message |
textType | string (EConversationMessageTextType) Enum: "SIMPLE_TEXT" "MARKDOWN" enum-descriptions: ["SIMPLE_TEXT: Text will be interpreted as simple text. <p> Auto link detection will still be possible.","MARKDOWN: Text will be interpreted as Markdown. <p> The supported Markdown subset depends on the message type."] How text in a conversation message should be interpreted. |
Array of objects (MultichoiceQuestionOption) [ items ] Response options for the question. | |
answerStatus | string (EAnswerStatus) Enum: "PENDING" "ANSWERED" "TIMEDOUT" "CANCELED" enum-descriptions: ["PENDING: Question is not answered yet","ANSWERED: Question was successfully answered","TIMEDOUT: Question was running into a timeout","CANCELED: Question was canceled by the system, a bot or an external messenger channel"] The state of a question message |
{- "$_type": "MultichoiceQuestionMessageData",
- "id": "string",
- "conversationId": "string",
- "externalMessengerChannelId": "string",
- "accountId": "string",
- "senderPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "senderPersonPresenceId": "string",
- "serverTimestamp": 0,
- "sendTimestamp": 0,
- "type": "TEXT",
- "recipientPersonIds": [
- "string"
], - "fallbackText": "string",
- "actionId": "string",
- "sourceId": "string",
- "text": "string",
- "textType": "SIMPLE_TEXT",
- "options": [
- {
- "$_type": "MultichoiceQuestionOption",
- "label": "string",
- "value": "string",
- "primary": true
}
], - "answerStatus": "PENDING"
}
$_type | string Default: "MultichoiceQuestionOption" Value: "MultichoiceQuestionOption" |
label | string Visual representation of the option |
value | string Value of the option, which is used in a |
primary | boolean Defines if the option is a primary or only a secondary choice. |
{- "$_type": "MultichoiceQuestionOption",
- "label": "string",
- "value": "string",
- "primary": true
}
$_type | string Default: "MultichoiceQuestionPostMessageData" Value: "MultichoiceQuestionPostMessageData" |
type | string (EPostMessageType) Enum: "TEXT" "FILE" "CARD" "LIST" "MULTICHOICE_QUESTION" "RATING_QUESTION" "TEXT_QUESTION" "REPLY" enum-descriptions: ["TEXT: See `TextPostMessageData`","FILE: See `FilePostMessageData`","CARD: See `CardPostMessageData`","LIST: See `ListPostMessageData`","MULTICHOICE_QUESTION: See `MultichoiceQuestionPostMessageData`","RATING_QUESTION: See `RatingQuestionPostMessageData`","TEXT_QUESTION: See `TextQuestionPostMessageData`","REPLY: See `ReplyPostMessageData`"] Type of a message which is send to the collaboration server |
fallbackText | string Optional fallback text which is used when:
The value must not contain markdown. If no fallback is given, a fallback text based on the content of the message is generated. This may however not always be a perfect textual representation of the message. |
text | string Question message text |
textType | string (EConversationMessageTextType) Enum: "SIMPLE_TEXT" "MARKDOWN" enum-descriptions: ["SIMPLE_TEXT: Text will be interpreted as simple text. <p> Auto link detection will still be possible.","MARKDOWN: Text will be interpreted as Markdown. <p> The supported Markdown subset depends on the message type."] How text in a conversation message should be interpreted. |
Array of objects (MultichoiceQuestionOption) [ items ] Response options for the question. |
{- "$_type": "MultichoiceQuestionPostMessageData",
- "type": "TEXT",
- "fallbackText": "string",
- "text": "string",
- "textType": "SIMPLE_TEXT",
- "options": [
- {
- "$_type": "MultichoiceQuestionOption",
- "label": "string",
- "value": "string",
- "primary": true
}
]
}
$_type | string Default: "NameAccountSearchFilter" Value: "NameAccountSearchFilter" |
field | string (EAccountSearchFilterField) Enum: "NAME" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["NAME: Filter by the 'name' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] |
any (StringOperator) |
{- "$_type": "NameAccountSearchFilter",
- "field": "NAME",
- "operator": {
- "$_type": "EqualsStringOperator",
- "type": "EQUALS",
- "value": "string"
}
}
$_type | string Default: "NameApiKeySearchFilter" Value: "NameApiKeySearchFilter" |
field | string (EApiKeySearchFilterField) Enum: "NAME" "DESCRIPTION" "API_KEY" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["NAME: Filter by the 'name' attribute","DESCRIPTION: Filter by the 'description' attribute","API_KEY: Filter by the 'apiKey' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] |
any (StringOperator) |
{- "$_type": "NameApiKeySearchFilter",
- "field": "NAME",
- "operator": {
- "$_type": "EqualsStringOperator",
- "type": "EQUALS",
- "value": "string"
}
}
$_type | string Default: "NameConversationTemplateSearchFilter" Value: "NameConversationTemplateSearchFilter" |
field | string (EConversationTemplateSearchFilterField) Enum: "NAME" "DESCRIPTION" "DEFAULT_TEMPLATE" "INITIAL_ENGAGEMENT_TYPE" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["NAME: Filter by the 'name' attribute","DESCRIPTION: Filter by the 'description' attribute","DEFAULT_TEMPLATE: Filter by the 'defaultTemplate' attribute","INITIAL_ENGAGEMENT_TYPE: Filter by the 'initialEngagementType' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] |
any (StringOperator) |
{- "$_type": "NameConversationTemplateSearchFilter",
- "field": "NAME",
- "operator": {
- "$_type": "EqualsStringOperator",
- "type": "EQUALS",
- "value": "string"
}
}
$_type | string Default: "NameDialogBotSearchFilter" Value: "NameDialogBotSearchFilter" |
field | string (EDialogBotSearchFilterField) Enum: "NAME" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["NAME: Filter by the 'name' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] |
any (StringOperator) |
{- "$_type": "NameDialogBotSearchFilter",
- "field": "NAME",
- "operator": {
- "$_type": "EqualsStringOperator",
- "type": "EQUALS",
- "value": "string"
}
}
$_type | string Default: "NameExternalMessengerChannelSearchFilter" Value: "NameExternalMessengerChannelSearchFilter" |
field | string (EExternalMessengerChannelSearchFilterField) Enum: "NAME" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["NAME: Filter by the 'name' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] |
any (StringOperator) |
{- "$_type": "NameExternalMessengerChannelSearchFilter",
- "field": "NAME",
- "operator": {
- "$_type": "EqualsStringOperator",
- "type": "EQUALS",
- "value": "string"
}
}
$_type | string Default: "NameNamedAreaSearchFilter" Value: "NameNamedAreaSearchFilter" |
field | string (ENamedAreaSearchFilterField) Enum: "NAME" "DESCRIPTION" "SITE_ID" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["NAME: Filter by the 'name' attribute","DESCRIPTION: Filter by the 'description' attribute","SITE_ID: Filter by the 'siteId' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] |
any (StringOperator) |
{- "$_type": "NameNamedAreaSearchFilter",
- "field": "NAME",
- "operator": {
- "$_type": "EqualsStringOperator",
- "type": "EQUALS",
- "value": "string"
}
}
$_type | string Default: "NameTeamSearchFilter" Value: "NameTeamSearchFilter" |
field | string (ETeamSearchFilterField) Enum: "NAME" "DESCRIPTION" "PARENT_ID" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["NAME: Filter by the 'name' attribute","DESCRIPTION: Filter by the 'description' attribute","PARENT_ID: Filter by the 'parentId' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] |
any (StringOperator) |
{- "$_type": "NameTeamSearchFilter",
- "field": "NAME",
- "operator": {
- "$_type": "EqualsStringOperator",
- "type": "EQUALS",
- "value": "string"
}
}
$_type | string Default: "NameWebhookRegistrationSearchFilter" Value: "NameWebhookRegistrationSearchFilter" |
field | string (EWebhookRegistrationSearchFilterField) Enum: "NAME" "DESCRIPTION" "ENDPOINT" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["NAME: Sort by the 'name' attribute","DESCRIPTION: Sort by the 'description' attribute","ENDPOINT: Sort by the 'endpoint' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] |
any (StringOperator) |
{- "$_type": "NameWebhookRegistrationSearchFilter",
- "field": "NAME",
- "operator": {
- "$_type": "EqualsStringOperator",
- "type": "EQUALS",
- "value": "string"
}
}
$_type | string Default: "NamedArea" Value: "NamedArea" |
id | string Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway. |
creationTimestamp | integer <int64> Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
modificationTimestamp | integer <int64> Timestamp of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
version | integer <int64> Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted. |
accountId | string Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
string or Avatar (object) expand-query-key: avatar type: ExpandableField Avatar of the entity: id that can be expanded. | |
name | string Name of the named area. Maximum of 250 characters. Can not be omitted. |
description | string Description of the named area. Maximum of 500 characters. Can be omitted. |
type | string (ENamedAreaType) Enum: "META_TAG" "DOMAIN" enum-descriptions: ["META_TAG: A meta tag","DOMAIN: a (sub)domain"] Type of a named area |
siteId | string Meta tag name if the type is META_TAG or domain name if the type is DOMAIN. If the type is META_TAG, it can be omitted during creation and a random ID will generated for it. Modification of this attribute is not allowed. Maximum of 250 characters. |
object expand-query-key: configuration type: Map The entity's configuration properties. Only contains values when the 'expand' query parameter is used with the value 'configuration'. | |
object expand-query-key: text type: Map The entity's text properties. Only contains values when the 'expand' query parameter is used with the value 'text'. | |
object expand-query-key: metadata type: Map The entity's metadata properties. Only contains values when the 'expand' query parameter is used with the value 'metadata'. |
{- "$_type": "NamedArea",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "avatar": "string",
- "name": "string",
- "description": "string",
- "type": "META_TAG",
- "siteId": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
$_type | string Default: "NamedAreaData" Value: "NamedAreaData" |
id | string Unique id of the named area. |
accountId | string Account id to which a named area belongs to. |
displayName | string Display-Name of the named area |
string or Avatar (object) expand-query-key: avatar type: ExpandableField Avatar of the named area: id that can be expanded. |
{- "$_type": "NamedAreaData",
- "id": "string",
- "accountId": "string",
- "displayName": "string",
- "avatar": "string"
}
$_type | string Default: "NamedAreaModificationEvent" Value: "NamedAreaModificationEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
action | string (EntityModificationAction) Enum: "CREATE" "UPDATE" "DELETE" enum-descriptions: ["CREATE: Entity was created","UPDATE: Entity was updated","DELETE: Entity was deleted"] Type of modification of an entity |
object (NamedArea) Model of named areas. They can either be domains or meta tags | |
object (UserInfo) User information which are normally used together with webhook events. |
{- "$_type": "NamedAreaModificationEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "action": "CREATE",
- "entity": {
- "$_type": "NamedArea",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "avatar": "string",
- "name": "string",
- "description": "string",
- "type": "META_TAG",
- "siteId": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "editingUser": {
- "$_type": "UserInfo",
- "userId": "string",
- "userName": "string",
- "firstName": "string",
- "lastName": "string",
- "displayName": "string"
}
}
$_type | string Default: "NamedAreaOrderBy" Value: "NamedAreaOrderBy" |
field | string (ENamedAreaOrderByField) Enum: "ID" "NAME" "DESCRIPTION" "SITE_ID" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["ID: Sort by the 'id' attribute","NAME: Sort by the 'name' attribute","DESCRIPTION: Sort by the 'description' attribute","SITE_ID: Sort by the 'siteId' attribute","CREATION_TIMESTAMP: Sort by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Sort by the 'modificationTimestamp' attribute"] |
order | string (Order) Enum: "ASCENDING" "DESCENDING" enum-descriptions: ["ASCENDING: Sort in the ascending order (smallest to largest, 0 to 9, and/or A to Z)","DESCENDING: Sort in the descending order (largest to smallest, 9 to 0, and/or Z to A)"] |
{- "$_type": "NamedAreaOrderBy",
- "field": "ID",
- "order": "ASCENDING"
}
$_type | string Default: "NamedAreaQuery" Value: "NamedAreaQuery" |
Array of any (NamedAreaSearchFilter) [ items ] List of filters to narrow the search of entities | |
Array of objects (NamedAreaOrderBy) [ items ] List of criteria to order the search result list | |
offset | integer <int32> Offset position in the result set to start pagination |
limit | integer <int32> Maximal amount of items returned |
{- "$_type": "NamedAreaQuery",
- "searchFilters": [
- {
- "$_type": "CreationTimestampNamedAreaSearchFilter",
- "field": "NAME",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
], - "orderBy": [
- {
- "$_type": "NamedAreaOrderBy",
- "field": "ID",
- "order": "ASCENDING"
}
], - "offset": 0,
- "limit": 0
}
$_type | string Default: "NamedAreaResult" Value: "NamedAreaResult" |
hasMoreItems | boolean Flag to indicate if there are more items on the server |
nextOffset | integer <int32> If more items are present on the server, this value can be used as offset in the next query |
Array of objects (NamedArea) [ items ] The returned list of entities |
{- "$_type": "NamedAreaResult",
- "hasMoreItems": true,
- "nextOffset": 0,
- "items": [
- {
- "$_type": "NamedArea",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "avatar": "string",
- "name": "string",
- "description": "string",
- "type": "META_TAG",
- "siteId": "string",
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "text": {
- "property1": {
- "property1": "string",
- "property2": "string"
}, - "property2": {
- "property1": "string",
- "property2": "string"
}
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
]
}
$_type | string Default: "CreationTimestampNamedAreaSearchFilter" Value: "CreationTimestampNamedAreaSearchFilter" |
field | string (ENamedAreaSearchFilterField) enum-descriptions: ["NAME: Filter by the 'name' attribute","DESCRIPTION: Filter by the 'description' attribute","SITE_ID: Filter by the 'siteId' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] CREATION_TIMESTAMP NAME DESCRIPTION SITE_ID CREATION_TIMESTAMP MODIFICATION_TIMESTAMP |
any (TimestampOperator) |
{- "$_type": "CreationTimestampNamedAreaSearchFilter",
- "field": "CREATION_TIMESTAMP",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
$_type | string Default: "NewMessagePushNotificationEvent" Value: "NewMessagePushNotificationEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
object (PersonData) Representation of a Person (Agent or Visitor). | |
locale | string Locale (as BCP 47 language tag form including region if available) |
conversationId | string Id of the conversation |
deviceTokens | Array of strings List of device tokens |
messageId | string Id of the message |
messageText | string Text of the message |
messageSendTimestamp | integer <int64> Timestamp when the message was sent |
messageServerTimestamp | integer <int64> Timestamp when the message was received by the server. |
senderName | string Name of the sender, can be null if the message was sent by the system. |
senderPersonId | string Person id of the sender, can be null if the message was sent by the system. |
notificationCount | integer <int32> Number of notifications (i.e. unread messages) in this conversation |
{- "$_type": "NewMessagePushNotificationEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "recipient": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "locale": "string",
- "conversationId": "string",
- "deviceTokens": [
- "string"
], - "messageId": "string",
- "messageText": "string",
- "messageSendTimestamp": 0,
- "messageServerTimestamp": 0,
- "senderName": "string",
- "senderPersonId": "string",
- "notificationCount": 0
}
$_type | string Default: "NicknamePersonSearchFilter" Value: "NicknamePersonSearchFilter" |
field | string (EPersonSearchFilterField) Enum: "PERSON_SOURCE" "SOURCE_ID" "SOURCE_DATA" "FIRST_NAME" "LAST_NAME" "USERNAME" "NICKNAME" "PERSON_TYPE" "AUTHORIZATION_ROLE" "EMAIL" "PHONE" "TEAM_ID" enum-descriptions: ["PERSON_SOURCE: Filter by the 'personSource' attribute","SOURCE_ID: Filter by the 'sourceId' attribute","SOURCE_DATA: Filter by the 'sourceData' attribute","FIRST_NAME: Filter by the 'firstName' attribute","LAST_NAME: Filter by the 'lastName' attribute","USERNAME: Filter by the 'username' attribute","NICKNAME: Filter by the 'nickname' attribute","PERSON_TYPE: Filter by the 'personType' attribute","AUTHORIZATION_ROLE: Filter by the 'authorizationRole' attribute","EMAIL: Filter by the 'email' attribute","PHONE: Filter by the 'phone' attribute","TEAM_ID: Filter by the 'teamId' attribute"] |
any (StringOperator) |
{- "$_type": "NicknamePersonSearchFilter",
- "field": "PERSON_SOURCE",
- "operator": {
- "$_type": "EqualsStringOperator",
- "type": "EQUALS",
- "value": "string"
}
}
$_type | string Default: "NotConversationEndReasonOperator" Value: "NotConversationEndReasonOperator" |
type | string (EConversationEndReasonOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator"] |
values | Array of strings (EConversationEndReason) Items Enum: "ENDED_BY_PARTICIPANT" "MANDATORY_PARTICIPANT_GONE" "EXTERNAL_CHANNEL_CLOSED" "SOLVED_BY_BOT" "OTHER" |
{- "$_type": "NotConversationEndReasonOperator",
- "type": "EQUALS",
- "values": [
- "ENDED_BY_PARTICIPANT"
]
}
$_type | string Default: "NotEqualsAuthorizationRoleOperator" Value: "NotEqualsAuthorizationRoleOperator" |
type | string (EAuthorizationRoleOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator"] |
value | string (EAuthorizationRole) Enum: "SUPER_ADMIN" "PARTNER" "TECHNICAL_ADMIN" "ADMIN" "SUPERVISOR" "REGISTERED_USER" "WEBUSER" "ANONYMOUS_USER" enum-descriptions: ["SUPER_ADMIN: Super admin role. Only for unblu or system admins","PARTNER: Partner role. (no longer used)","TECHNICAL_ADMIN: Technical admin role.","ADMIN: Admin role. For Admins of the system","SUPERVISOR: Supervisor role. For users which manage teams","REGISTERED_USER: User role. For normal users (agents)","WEBUSER: Webuser role. For internal representation of users from the outside","ANONYMOUS_USER: Anonymous role. For internal representation of unknown users"] The authorization role is mainly used for access definition of a service |
{- "$_type": "NotEqualsAuthorizationRoleOperator",
- "type": "EQUALS",
- "value": "SUPER_ADMIN"
}
$_type | string Default: "NotEqualsBooleanOperator" Value: "NotEqualsBooleanOperator" |
type | string (EBooleanOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IS_NULL" "IS_NOT_NULL" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IS_NULL: Check if the value is null","IS_NOT_NULL: Check if the value is not null"] |
value | boolean |
{- "$_type": "NotEqualsBooleanOperator",
- "type": "EQUALS",
- "value": true
}
$_type | string Default: "NotEqualsConversationEndReasonOperator" Value: "NotEqualsConversationEndReasonOperator" |
type | string (EConversationEndReasonOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator"] |
value | string (EConversationEndReason) Enum: "ENDED_BY_PARTICIPANT" "MANDATORY_PARTICIPANT_GONE" "EXTERNAL_CHANNEL_CLOSED" "SOLVED_BY_BOT" "OTHER" enum-descriptions: ["ENDED_BY_PARTICIPANT","MANDATORY_PARTICIPANT_GONE","EXTERNAL_CHANNEL_CLOSED","SOLVED_BY_BOT","OTHER"] Closing reason of a conversation |
{- "$_type": "NotEqualsConversationEndReasonOperator",
- "type": "EQUALS",
- "value": "ENDED_BY_PARTICIPANT"
}
$_type | string Default: "NotEqualsConversationRecipientTypeOperator" Value: "NotEqualsConversationRecipientTypeOperator" |
type | string (EConversationRecipientTypeOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator"] |
value | string (EConversationRecipientType) Enum: "AGENT" "TEAM" "NAMED_AREA" "ACCOUNT" enum-descriptions: ["AGENT: Recipient is a single agent","TEAM: Recipient is an agent of the team","NAMED_AREA: Recipient is an agent responsible for a specific named-area","ACCOUNT: Recipient is one of all the agents of an account"] Recipient type of the conversation |
{- "$_type": "NotEqualsConversationRecipientTypeOperator",
- "type": "EQUALS",
- "value": "AGENT"
}
$_type | string Default: "NotEqualsConversationStateOperator" Value: "NotEqualsConversationStateOperator" |
type | string (EConversationStateOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator"] |
value | string (EConversationState) Enum: "CREATED" "ONBOARDING" "REBOARDING" "QUEUED" "ACTIVE" "UNASSIGNED" "OFFBOARDING" "ENDED" enum-descriptions: ["CREATED: Initial state of a conversation","ONBOARDING: Depending of the engagement type of the conversation, the conversation stays in the onboarding state as long as the person in the center of the conversation is doing his onboarding","REBOARDING: When a message is send to an unassigned conversation, the conversation first is put into the reboarding state as long as the person in the center of the conversation is doing the reboarding.","QUEUED: Depending of the engagement type of the conversation, the conversation is put in the queued state when it is inside the queue.","ACTIVE: Conversation is active","UNASSIGNED: After there is no assignee of a conversation anymore, the conversation goes to unassigned state until a message from a visitor is written to start reboarding again.","OFFBOARDING: Conversation is being ended","ENDED: Conversation is ended"] Life cycle state of the conversation. Following transitions are possible:
|
{- "$_type": "NotEqualsConversationStateOperator",
- "type": "EQUALS",
- "value": "CREATED"
}
$_type | string Default: "NotEqualsIdOperator" Value: "NotEqualsIdOperator" |
type | string (EIdOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" "IS_NULL" "IS_NOT_NULL" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator","IS_NULL: Check if the value is null","IS_NOT_NULL: Check if the value is not null"] Operator types corresponding to operators defined by |
value | string |
{- "$_type": "NotEqualsIdOperator",
- "type": "EQUALS",
- "value": "string"
}
$_type | string Default: "NotEqualsInitialEngagementTypeOperator" Value: "NotEqualsInitialEngagementTypeOperator" |
type | string (EInitialEngagementTypeOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator"] |
value | string (EInitialEngagementType) Enum: "CHAT_REQUEST" "OFFLINE_CHAT_REQUEST" "VIDEO_REQUEST" "AUDIO_REQUEST" "HEADLESS_BROWSER_REQUEST" "DOMCAP_BROWSER_REQUEST" "MOBILE_COBROWSING_REQUEST" "SCREEN_SHARING_REQUEST" "VISITOR_COBROWSING" "HEADLESS_PIN" "DOMCAP_PIN" "MOBILE_PIN" "SCREEN_SHARING_PIN" "CHAT_INVITE" "HEADLESS_INVITE" "SCREEN_SHARING_INVITE" enum-descriptions: ["CHAT_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming chat conversation.","OFFLINE_CHAT_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming chat conversation while all agents are offline.","VIDEO_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming video conversation.","AUDIO_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming audio conversation.","HEADLESS_BROWSER_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming universal co-browsing conversation.","DOMCAP_BROWSER_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming embedded co-browsing conversation.","MOBILE_COBROWSING_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming mobile co-browsing conversation.","SCREEN_SHARING_REQUEST: (Visitor initiated, visitor centered) A visitor creates an incoming screen sharing conversation.","VISITOR_COBROWSING: (Api initiated, visitor centered) A visitor creates a conversation via API which is not added to the queue and where he can invite other visitor to do embedded","HEADLESS_PIN: (Agent initiated, visitor centered) An agent creates a conversation with a PIN invitation for the visitor to join an universal co-browsing conversation.","DOMCAP_PIN: (Agent initiated, visitor centered) An agent creates a conversation with a PIN invitation for the visitor to join an embedded co-browsing conversation.","MOBILE_PIN: (Agent initiated, visitor centered) An agent creates a conversation with a PIN invitation for the visitor to join a mobile co-browsing conversation.","SCREEN_SHARING_PIN: (Agent initiated, visitor centered) An agent creates a conversation with a PIN invitation for the visitor to join a screen sharing conversation.","CHAT_INVITE: (Agent initiated, agent centered) An agent creates a chat conversation (this is the recommended initial engagement type for conversation created with the Web API).","HEADLESS_INVITE: (Agent initiated, agent centered) An agent creates universal co-browsing conversation and invites customer later.","SCREEN_SHARING_INVITE: (Agent initiated, agent centered) An agent creates screen sharing conversation and invites customer later."] The initial type of a conversation. The type used at creation time of the conversation determines the conversation template that is used. |
{- "$_type": "NotEqualsInitialEngagementTypeOperator",
- "type": "EQUALS",
- "value": "CHAT_REQUEST"
}
$_type | string Default: "NotEqualsInvitationCreatorTypeOperator" Value: "NotEqualsInvitationCreatorTypeOperator" |
type | string (EInvitationCreatorTypeOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator"] |
value | string (EInvitationCreatorType) Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR" enum-descriptions: ["WEB_API: Invitation created with the API","SYSTEM: Invitation created by the system","AGENT: Invitation created by an agent","VISITOR: Invitation created by a visitor"] The type of the person/system who created an invitation |
{- "$_type": "NotEqualsInvitationCreatorTypeOperator",
- "type": "EQUALS",
- "value": "WEB_API"
}
$_type | string Default: "NotEqualsInvitationTargetTypeOperator" Value: "NotEqualsInvitationTargetTypeOperator" |
type | string (EInvitationTargetTypeOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator"] |
value | string (EInvitationTargetType) Enum: "ANONYMOUS" "VISITOR" "AGENT" "TEAM" "NAMED_AREA" "ACCOUNT" enum-descriptions: ["ANONYMOUS","VISITOR","AGENT","TEAM","NAMED_AREA","ACCOUNT"] |
{- "$_type": "NotEqualsInvitationTargetTypeOperator",
- "type": "EQUALS",
- "value": "ANONYMOUS"
}
$_type | string Default: "NotEqualsInvitationTypeOperator" Value: "NotEqualsInvitationTypeOperator" |
type | string (EInvitationTypeOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator"] |
value | string (EInvitationType) Enum: "CONVERSATION_REQUEST" "AGENT_FORWARDING" "AGENT_INVITATION" "VISITOR_INVITATION" "PIN_CONVERSATION" enum-descriptions: ["CONVERSATION_REQUEST: All visitor conversation requests e.g. Voice / Video-Call, Co-Browsing Request, etc.","AGENT_FORWARDING: Conversation forwarding to an other agent, directly or via a team. <ul> <li>The forwarding agent will leave the conversation once it has been accepted.</li> <li>The assignee will change to the forwarded agent once it has been accepted.</li> </ul>","AGENT_INVITATION: Invites an other agent into the conversation, directly or via a team. <ul> <li>The inviting agent stays in the conversation.</li> <li>The assignee will NOT change when the invited agent accepts the invitation.</li> </ul>","VISITOR_INVITATION: Anonymous Visitor invitation <ul> <li>Anyone with the invitations ticket (and the accounts API key) may enter the conversation as a Visitor.</li> <li>Once the invitation has been redeemed it can not be reused by other Visitors.</li> </ul>","PIN_CONVERSATION: Universal / Embedded / Mobile PIN Session. <ul> <li>The conversation doesn't really start until the invitation is redeemed.</li> <li>Anyone with the invitations ticket (and the accounts API key) may enter the conversation as a Visitor.</li> <li>Once the ticket has been redeemed it can not be reused by other Visitors.</li> </ul>"] |
{- "$_type": "NotEqualsInvitationTypeOperator",
- "type": "EQUALS",
- "value": "CONVERSATION_REQUEST"
}
$_type | string Default: "NotEqualsLongOperator" Value: "NotEqualsLongOperator" |
type | string (ELongOperatorType) Enum: "EQUALS" "NOT_EQUALS" "GREATER_THAN" "LOWER_THAN" "IN_RANGE" "NOT_IN_RANGE" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","GREATER_THAN: Check if the value is greater than the one provided in the operator","LOWER_THAN: Check if the value is lower than the one provided in the operator","IN_RANGE: Check if the value is in the range of the provided values. Results equal to the provided values are included.","NOT_IN_RANGE: Check if the value is NOT in the range of the provided values. Results equal to the provided values are not included."] |
value | integer <int64> |
{- "$_type": "NotEqualsLongOperator",
- "type": "EQUALS",
- "value": 0
}
$_type | string Default: "NotEqualsPersonSourceOperator" Value: "NotEqualsPersonSourceOperator" |
type | string (EPersonSourceOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator"] |
value | string (EPersonSource) Enum: "USER_DB" "VIRTUAL" enum-descriptions: ["USER_DB: Person-Source is on the main_user table","VIRTUAL: Person-Source is only virtual (no seperate storage)"] The source type of a person (participant of a conversation) |
{- "$_type": "NotEqualsPersonSourceOperator",
- "type": "EQUALS",
- "value": "USER_DB"
}
$_type | string Default: "NotEqualsPersonTypeOperator" Value: "NotEqualsPersonTypeOperator" |
type | string (EPersonTypeOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator"] |
value | string (EPersonType) Enum: "AGENT" "VISITOR" "SYSTEM" "BOT" enum-descriptions: ["AGENT: Agent participant","VISITOR: Visitor participant","SYSTEM: System participant","BOT: Bot participant"] The type of a person (participant of a session) |
{- "$_type": "NotEqualsPersonTypeOperator",
- "type": "EQUALS",
- "value": "AGENT"
}
$_type | string Default: "NotEqualsStringOperator" Value: "NotEqualsStringOperator" |
type | string (EStringOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" "IS_NULL" "IS_NOT_NULL" "CONTAINS" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator","IS_NULL: Check if the value is null","IS_NOT_NULL: Check if the value is not null","CONTAINS: Check if the value contains the string provided in the operator"] |
value | string |
{- "$_type": "NotEqualsStringOperator",
- "type": "EQUALS",
- "value": "string"
}
$_type | string Default: "NotEqualsTimestampOperator" Value: "NotEqualsTimestampOperator" |
type | string (ETimestampOperatorType) Enum: "EQUALS" "NOT_EQUALS" "GREATER_THAN" "LOWER_THAN" "IN" "NOT_IN" "IS_NULL" "IS_NOT_NULL" "IN_RANGE" "NOT_IN_RANGE" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","GREATER_THAN: Check if the value is greater than the one provided in the operator","LOWER_THAN: Check if the value is lower than the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator","IS_NULL: Check if the value is null","IS_NOT_NULL: Check if the value is not null","IN_RANGE: Check if the value is in the range of the provided values. Results equal to the provided values are included.","NOT_IN_RANGE: Check if the value is NOT in the range of the provided values. Results equal to the provided values are not included."] |
value | integer <int64> |
{- "$_type": "NotEqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
$_type | string Default: "NotInAuthorizationRoleOperator" Value: "NotInAuthorizationRoleOperator" |
type | string (EAuthorizationRoleOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator"] |
values | Array of strings (EAuthorizationRole) Items Enum: "SUPER_ADMIN" "PARTNER" "TECHNICAL_ADMIN" "ADMIN" "SUPERVISOR" "REGISTERED_USER" "WEBUSER" "ANONYMOUS_USER" |
{- "$_type": "NotInAuthorizationRoleOperator",
- "type": "EQUALS",
- "values": [
- "SUPER_ADMIN"
]
}
$_type | string Default: "NotInConversationRecipientTypeOperator" Value: "NotInConversationRecipientTypeOperator" |
type | string (EConversationRecipientTypeOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator"] |
values | Array of strings (EConversationRecipientType) Items Enum: "AGENT" "TEAM" "NAMED_AREA" "ACCOUNT" |
{- "$_type": "NotInConversationRecipientTypeOperator",
- "type": "EQUALS",
- "values": [
- "AGENT"
]
}
$_type | string Default: "NotInConversationStateOperator" Value: "NotInConversationStateOperator" |
type | string (EConversationStateOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator"] |
values | Array of strings (EConversationState) Items Enum: "CREATED" "ONBOARDING" "REBOARDING" "QUEUED" "ACTIVE" "UNASSIGNED" "OFFBOARDING" "ENDED" |
{- "$_type": "NotInConversationStateOperator",
- "type": "EQUALS",
- "values": [
- "CREATED"
]
}
$_type | string Default: "NotInIdOperator" Value: "NotInIdOperator" |
type | string (EIdOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" "IS_NULL" "IS_NOT_NULL" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator","IS_NULL: Check if the value is null","IS_NOT_NULL: Check if the value is not null"] Operator types corresponding to operators defined by |
values | Array of strings |
{- "$_type": "NotInIdOperator",
- "type": "EQUALS",
- "values": [
- "string"
]
}
$_type | string Default: "NotInInitialEngagementTypeOperator" Value: "NotInInitialEngagementTypeOperator" |
type | string (EInitialEngagementTypeOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator"] |
values | Array of strings (EInitialEngagementType) Items Enum: "CHAT_REQUEST" "OFFLINE_CHAT_REQUEST" "VIDEO_REQUEST" "AUDIO_REQUEST" "HEADLESS_BROWSER_REQUEST" "DOMCAP_BROWSER_REQUEST" "MOBILE_COBROWSING_REQUEST" "SCREEN_SHARING_REQUEST" "VISITOR_COBROWSING" "HEADLESS_PIN" "DOMCAP_PIN" "MOBILE_PIN" "SCREEN_SHARING_PIN" "CHAT_INVITE" "HEADLESS_INVITE" "SCREEN_SHARING_INVITE" |
{- "$_type": "NotInInitialEngagementTypeOperator",
- "type": "EQUALS",
- "values": [
- "CHAT_REQUEST"
]
}
$_type | string Default: "NotInInvitationCreatorTypeOperator" Value: "NotInInvitationCreatorTypeOperator" |
type | string (EInvitationCreatorTypeOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator"] |
values | Array of strings (EInvitationCreatorType) Items Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR" |
{- "$_type": "NotInInvitationCreatorTypeOperator",
- "type": "EQUALS",
- "values": [
- "WEB_API"
]
}
$_type | string Default: "NotInInvitationTargetTypeOperator" Value: "NotInInvitationTargetTypeOperator" |
type | string (EInvitationTargetTypeOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator"] |
values | Array of strings (EInvitationTargetType) Items Enum: "ANONYMOUS" "VISITOR" "AGENT" "TEAM" "NAMED_AREA" "ACCOUNT" |
{- "$_type": "NotInInvitationTargetTypeOperator",
- "type": "EQUALS",
- "values": [
- "ANONYMOUS"
]
}
$_type | string Default: "NotInInvitationTypeOperator" Value: "NotInInvitationTypeOperator" |
type | string (EInvitationTypeOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator"] |
values | Array of strings (EInvitationType) Items Enum: "CONVERSATION_REQUEST" "AGENT_FORWARDING" "AGENT_INVITATION" "VISITOR_INVITATION" "PIN_CONVERSATION" |
{- "$_type": "NotInInvitationTypeOperator",
- "type": "EQUALS",
- "values": [
- "CONVERSATION_REQUEST"
]
}
$_type | string Default: "NotInPersonSourceOperator" Value: "NotInPersonSourceOperator" |
type | string (EPersonSourceOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator"] |
values | Array of strings (EPersonSource) Items Enum: "USER_DB" "VIRTUAL" |
{- "$_type": "NotInPersonSourceOperator",
- "type": "EQUALS",
- "values": [
- "USER_DB"
]
}
$_type | string Default: "NotInPersonTypeOperator" Value: "NotInPersonTypeOperator" |
type | string (EPersonTypeOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator"] |
values | Array of strings (EPersonType) Items Enum: "AGENT" "VISITOR" "SYSTEM" "BOT" |
{- "$_type": "NotInPersonTypeOperator",
- "type": "EQUALS",
- "values": [
- "AGENT"
]
}
$_type | string Default: "NotInRangeLongOperator" Value: "NotInRangeLongOperator" |
type | string (ELongOperatorType) Enum: "EQUALS" "NOT_EQUALS" "GREATER_THAN" "LOWER_THAN" "IN_RANGE" "NOT_IN_RANGE" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","GREATER_THAN: Check if the value is greater than the one provided in the operator","LOWER_THAN: Check if the value is lower than the one provided in the operator","IN_RANGE: Check if the value is in the range of the provided values. Results equal to the provided values are included.","NOT_IN_RANGE: Check if the value is NOT in the range of the provided values. Results equal to the provided values are not included."] |
minimum | integer <int64> |
maximum | integer <int64> |
{- "$_type": "NotInRangeLongOperator",
- "type": "EQUALS",
- "minimum": 0,
- "maximum": 0
}
$_type | string Default: "NotInRangeTimestampOperator" Value: "NotInRangeTimestampOperator" |
type | string (ETimestampOperatorType) Enum: "EQUALS" "NOT_EQUALS" "GREATER_THAN" "LOWER_THAN" "IN" "NOT_IN" "IS_NULL" "IS_NOT_NULL" "IN_RANGE" "NOT_IN_RANGE" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","GREATER_THAN: Check if the value is greater than the one provided in the operator","LOWER_THAN: Check if the value is lower than the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator","IS_NULL: Check if the value is null","IS_NOT_NULL: Check if the value is not null","IN_RANGE: Check if the value is in the range of the provided values. Results equal to the provided values are included.","NOT_IN_RANGE: Check if the value is NOT in the range of the provided values. Results equal to the provided values are not included."] |
minimum | integer <int64> |
maximum | integer <int64> |
{- "$_type": "NotInRangeTimestampOperator",
- "type": "EQUALS",
- "minimum": 0,
- "maximum": 0
}
$_type | string Default: "NotInStringOperator" Value: "NotInStringOperator" |
type | string (EStringOperatorType) Enum: "EQUALS" "NOT_EQUALS" "IN" "NOT_IN" "IS_NULL" "IS_NOT_NULL" "CONTAINS" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator","IS_NULL: Check if the value is null","IS_NOT_NULL: Check if the value is not null","CONTAINS: Check if the value contains the string provided in the operator"] |
values | Array of strings |
{- "$_type": "NotInStringOperator",
- "type": "EQUALS",
- "values": [
- "string"
]
}
$_type | string Default: "NotInTimestampOperator" Value: "NotInTimestampOperator" |
type | string (ETimestampOperatorType) Enum: "EQUALS" "NOT_EQUALS" "GREATER_THAN" "LOWER_THAN" "IN" "NOT_IN" "IS_NULL" "IS_NOT_NULL" "IN_RANGE" "NOT_IN_RANGE" enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","GREATER_THAN: Check if the value is greater than the one provided in the operator","LOWER_THAN: Check if the value is lower than the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator","IS_NULL: Check if the value is null","IS_NOT_NULL: Check if the value is not null","IN_RANGE: Check if the value is in the range of the provided values. Results equal to the provided values are included.","NOT_IN_RANGE: Check if the value is NOT in the range of the provided values. Results equal to the provided values are not included."] |
values | Array of integers <int64> [ items <int64 > ] |
{- "$_type": "NotInTimestampOperator",
- "type": "EQUALS",
- "values": [
- 0
]
}
"ASCENDING"
$_type | string Default: "ParentIdTeamSearchFilter" Value: "ParentIdTeamSearchFilter" |
field | string (ETeamSearchFilterField) Enum: "NAME" "DESCRIPTION" "PARENT_ID" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["NAME: Filter by the 'name' attribute","DESCRIPTION: Filter by the 'description' attribute","PARENT_ID: Filter by the 'parentId' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] |
any (IdOperator) Defines operators used for comparing id fields in tables. |
{- "$_type": "ParentIdTeamSearchFilter",
- "field": "NAME",
- "operator": {
- "$_type": "EqualsIdOperator",
- "type": "EQUALS",
- "value": "string"
}
}
$_type | string Default: "ParticipantData" Value: "ParticipantData" |
state | string (EConversationParticipationState) Enum: "CREATED" "ONBOARDING" "ACTIVE" "OFFBOARDING" "ENDED" enum-descriptions: ["CREATED: Participant has been created","ONBOARDING: Participant is doing the onboarding to join the conversation","ACTIVE: Participant has joined the conversation and is an active member","OFFBOARDING: Participant is doing the offboarding to leave the conversation","ENDED: Participant is no longer present in the conversation"] The state of a participation inside a conversation. Following transitions are possible:
|
personId | string Id of the participant person |
connectedViaExternalMessenger | boolean Indicates if the participant is connected to a messenger channel |
hidden | boolean Indicates if the participant should be hidden |
conversationStarred | boolean Indicates whether this conversation is starred for the participant or not |
{- "$_type": "ParticipantData",
- "state": "CREATED",
- "personId": "string",
- "connectedViaExternalMessenger": true,
- "hidden": true,
- "conversationStarred": true
}
$_type | string Default: "ParticipantHistoryData" Value: "ParticipantHistoryData" |
state | string (EConversationParticipationState) Enum: "CREATED" "ONBOARDING" "ACTIVE" "OFFBOARDING" "ENDED" enum-descriptions: ["CREATED: Participant has been created","ONBOARDING: Participant is doing the onboarding to join the conversation","ACTIVE: Participant has joined the conversation and is an active member","OFFBOARDING: Participant is doing the offboarding to leave the conversation","ENDED: Participant is no longer present in the conversation"] The state of a participation inside a conversation. Following transitions are possible:
|
createdTimestamp | integer <int64> utc timestamp when the person participation was created (timestamp when the state was set to |
joinedTimestamp | integer <int64> utc timestamp when the person has joined (timestamp when the state was set to |
activationTimestamp | integer <int64> utc timestamp when the participation was activated, can be null (timestamp when the state was set to |
offboardingTimestamp | integer <int64> utc timestamp when the person started offboarding, can be null (timestamp when the state was set to |
leftTimestamp | integer <int64> utc timestamp when the person has left, can be null (timestamp when the state was set to |
conversationRating | number <float> Rating (between 0 and 1) for the conversation given by the participant |
isHidden | boolean Indicates if the participant is hidden in the current conversation. |
conversationStarred | boolean Indicates whether this conversation is starred for the participant or not |
object (PersonData) Representation of a Person (Agent or Visitor). |
{- "$_type": "ParticipantHistoryData",
- "state": "CREATED",
- "createdTimestamp": 0,
- "joinedTimestamp": 0,
- "activationTimestamp": 0,
- "offboardingTimestamp": 0,
- "leftTimestamp": 0,
- "conversationRating": 0,
- "isHidden": true,
- "conversationStarred": true,
- "person": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}
}
$_type | string Default: "ParticipantPersonIdConversationSearchFilter" Value: "ParticipantPersonIdConversationSearchFilter" |
field | string (EConversationSearchFilterField) Enum: "CREATION_TIMESTAMP" "END_TIMESTAMP" "INITIAL_ENGAGEMENT_TYPE" "TOPIC" "CONTEXT_PERSON_ID" "ASSIGNEE_PERSON_ID" "PARTICIPANT_PERSON_ID" "STATE" "END_REASON" "CONVERSATION_TEMPLATE_ID" "RECIPIENT_ID" "RECIPIENT_TYPE" "TOKBOX_SESSION_ID" enum-descriptions: ["CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","END_TIMESTAMP: Filter by the 'endTimestamp' attribute","INITIAL_ENGAGEMENT_TYPE: Filter by the 'initialEngagementType' attribute","TOPIC: Filter by the 'topic' attribute","CONTEXT_PERSON_ID: Filter by the 'contextPersonId' attribute","ASSIGNEE_PERSON_ID: Filter by the 'assigneePersonId' attribute","PARTICIPANT_PERSON_ID: Filter by the 'personId' of the participants","STATE: Filter by the 'state' attribute","END_REASON: Filter by the 'endReason' attribute","CONVERSATION_TEMPLATE_ID: Filter by the 'conversationTemplateId' attribute","RECIPIENT_ID: Filter by the 'id' of the 'recipient' attribute","RECIPIENT_TYPE: Filter by the 'type' of the 'recipient' attribute","TOKBOX_SESSION_ID: Filter by the 'tokboxSessionId' attribute"] |
any (IdListOperator) Defines operators used for comparing lists of id fields. |
{- "$_type": "ParticipantPersonIdConversationSearchFilter",
- "field": "CREATION_TIMESTAMP",
- "operator": {
- "$_type": "AllOfIdListOperator",
- "type": "ALL_OF",
- "values": [
- "string"
]
}
}
$_type | string Default: "Permissions" Value: "Permissions" |
allPermissions | boolean Flag that indicates that all permissions are granted, ignoring the permissions entries |
permissions | Array of strings all permissions of the user |
{- "$_type": "Permissions",
- "allPermissions": true,
- "permissions": [
- "string"
]
}
$_type | string Default: "PersonData" Value: "PersonData" |
id | string Unique id of the person, when creating a person this property can be omitted as it will be generated by the server anyway. |
accountId | string Account id to which a Person belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
personSource | string (EPersonSource) Enum: "USER_DB" "VIRTUAL" enum-descriptions: ["USER_DB: Person-Source is on the main_user table","VIRTUAL: Person-Source is only virtual (no seperate storage)"] The source type of a person (participant of a conversation) |
sourceId | string Identifier of the person in its source (defined by |
sourceData | string Vendor specific data. |
firstName | string The first name of the person. Maximum length of 250 characters. Can be omitted. |
lastName | string the last name of the person. Maximum length of 250 characters. Can be omitted. |
username | string The username of the person. When firstName and lastName are unknown, it is recommended to use this value to change the displayName. Depending on the configuration, this is may also be the email of the corresponding user. Maximum length of 250 characters. Can be omitted. |
nickname | string A name that an anonymous person has given itself. Maximum length of 250 characters. Can be omitted. |
displayName | string Display name of the person. This is read only information, it will be set by the server anyway. |
personType | string (EPersonType) Enum: "AGENT" "VISITOR" "SYSTEM" "BOT" enum-descriptions: ["AGENT: Agent participant","VISITOR: Visitor participant","SYSTEM: System participant","BOT: Bot participant"] The type of a person (participant of a session) |
authorizationRole | string (EAuthorizationRole) Enum: "SUPER_ADMIN" "PARTNER" "TECHNICAL_ADMIN" "ADMIN" "SUPERVISOR" "REGISTERED_USER" "WEBUSER" "ANONYMOUS_USER" enum-descriptions: ["SUPER_ADMIN: Super admin role. Only for unblu or system admins","PARTNER: Partner role. (no longer used)","TECHNICAL_ADMIN: Technical admin role.","ADMIN: Admin role. For Admins of the system","SUPERVISOR: Supervisor role. For users which manage teams","REGISTERED_USER: User role. For normal users (agents)","WEBUSER: Webuser role. For internal representation of users from the outside","ANONYMOUS_USER: Anonymous role. For internal representation of unknown users"] The authorization role is mainly used for access definition of a service |
string The email of the person. Optional. | |
phone | string The phone of the person. Optional. |
teamId | string Team id of the person. Optional. |
teamName | string Team name of the person, only present when the team id is set. When creating or updating a person this property can be omitted as it will be set by the server anyway. |
string or Avatar (object) expand-query-key: avatar type: ExpandableField Avatar of the entity: id that can be expanded. | |
object expand-query-key: metadata type: Map The entity's metadata properties. Only contains values when the 'expand' query parameter is used with the value 'metadata'. |
{- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}
$_type | string Default: "PersonIdPersonPresenceSearchFilter" Value: "PersonIdPersonPresenceSearchFilter" |
field | string (EPersonPresenceSearchFilterField) Enum: "JOINED_TIMESTAMP" "LEFT_TIMESTAMP" "PERSON_ID" enum-descriptions: ["JOINED_TIMESTAMP: Filter by the 'joindTimestamp' attribute","LEFT_TIMESTAMP: Filter by the 'leftTimestamp' attribute","PERSON_ID: Filter by the 'personId' attribute"] |
any (StringOperator) |
{- "$_type": "PersonIdPersonPresenceSearchFilter",
- "field": "JOINED_TIMESTAMP",
- "operator": {
- "$_type": "EqualsStringOperator",
- "type": "EQUALS",
- "value": "string"
}
}
$_type | string Default: "PersonModificationEvent" Value: "PersonModificationEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
action | string (EntityModificationAction) Enum: "CREATE" "UPDATE" "DELETE" enum-descriptions: ["CREATE: Entity was created","UPDATE: Entity was updated","DELETE: Entity was deleted"] Type of modification of an entity |
object (PersonData) Representation of a Person (Agent or Visitor). | |
object (UserInfo) User information which are normally used together with webhook events. |
{- "$_type": "PersonModificationEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "action": "CREATE",
- "entity": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "editingUser": {
- "$_type": "UserInfo",
- "userId": "string",
- "userName": "string",
- "firstName": "string",
- "lastName": "string",
- "displayName": "string"
}
}
$_type | string Default: "PersonOrderBy" Value: "PersonOrderBy" |
field | string (EPersonOrderByField) Enum: "ID" "PERSON_SOURCE" "SOURCE_ID" "SOURCE_DATA" "FIRST_NAME" "LAST_NAME" "USERNAME" "NICKNAME" "PERSON_TYPE" "AUTHORIZATION_ROLE" "EMAIL" "PHONE" "TEAM_ID" enum-descriptions: ["ID: Sort by the 'id' attribute","PERSON_SOURCE: Sort by the 'personSource' attribute","SOURCE_ID: Sort by the 'sourceId' attribute","SOURCE_DATA: Sort by the 'sourceData' attribute","FIRST_NAME: Sort by the 'firstName' attribute","LAST_NAME: Sort by the 'lastName' attribute","USERNAME: Sort by the 'username' attribute","NICKNAME: Sort by the 'nickname' attribute","PERSON_TYPE: Sort by the 'personType' attribute","AUTHORIZATION_ROLE: Sort by the 'authorizationRole' attribute","EMAIL: Sort by the 'email' attribute","PHONE: Sort by the 'phone' attribute","TEAM_ID: Sort by the 'teamId' attribute"] |
order | string (Order) Enum: "ASCENDING" "DESCENDING" enum-descriptions: ["ASCENDING: Sort in the ascending order (smallest to largest, 0 to 9, and/or A to Z)","DESCENDING: Sort in the descending order (largest to smallest, 9 to 0, and/or Z to A)"] |
{- "$_type": "PersonOrderBy",
- "field": "ID",
- "order": "ASCENDING"
}
$_type | string Default: "PersonPresenceData" Value: "PersonPresenceData" |
id | string Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway. |
creationTimestamp | integer <int64> Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
modificationTimestamp | integer <int64> Timestamp of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
accountId | string Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
joinedTimestamp | integer <int64> utc timestamp when the person has joined |
leftTimestamp | integer <int64> utc timestamp when the person has left (may not be present or -1 if still online) |
personId | string Person id to which an entity belongs to |
object (DeviceInfo) Model of a device (os, browser, etc) This is the representation of a physical device which may browsers (desktop and mobile) if accessed via the website or actual devices if accessed via the unblu MobileSDK | |
touchTimestamp | integer <int64> Deprecated, will be removed in v4 |
impersonationType | string (EImpersonationType) Enum: "NONE" "USER_OWN_ROLE" "USER_SUPER_ADMIN" "ACCOUNT" enum-descriptions: ["NONE","USER_OWN_ROLE","USER_SUPER_ADMIN","ACCOUNT"] Type of impersonation |
impersonatedFromUserId | string |
impersonatedFromAccountId | string |
additionalInfo | string |
authInfo | string |
propagated | boolean |
{- "$_type": "PersonPresenceData",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "accountId": "string",
- "joinedTimestamp": 0,
- "leftTimestamp": 0,
- "personId": "string",
- "deviceInfo": {
- "$_type": "DeviceInfo",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "accountId": "string",
- "osName": "string",
- "osVersion": "string",
- "browserName": "string",
- "browserVersion": "string",
- "userAgent": "string",
- "screenWidth": 0,
- "screenHeight": 0,
- "screenPixelRatio": 0,
- "type": "MOBILE",
- "identifier": "string",
- "identifierSource": "COOKIE",
- "pushToken": "string",
- "ownerPersonId": "string"
}, - "touchTimestamp": 0,
- "impersonationType": "NONE",
- "impersonatedFromUserId": "string",
- "impersonatedFromAccountId": "string",
- "additionalInfo": "string",
- "authInfo": "string",
- "propagated": true
}
$_type | string Default: "PersonPresenceOrderBy" Value: "PersonPresenceOrderBy" |
field | string (EPersonPresenceOrderByField) Enum: "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["CREATION_TIMESTAMP: Sort by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Sort by the 'modificationTimestamp' attribute"] |
order | string (Order) Enum: "ASCENDING" "DESCENDING" enum-descriptions: ["ASCENDING: Sort in the ascending order (smallest to largest, 0 to 9, and/or A to Z)","DESCENDING: Sort in the descending order (largest to smallest, 9 to 0, and/or Z to A)"] |
{- "$_type": "PersonPresenceOrderBy",
- "field": "CREATION_TIMESTAMP",
- "order": "ASCENDING"
}
$_type | string Default: "PersonPresenceQuery" Value: "PersonPresenceQuery" |
Array of any (PersonPresenceSearchFilter) [ items ] List of filters to narrow the search of entities | |
Array of objects (PersonPresenceOrderBy) [ items ] List of criteria to order the search result list | |
offset | integer <int32> Offset position in the result set to start pagination |
limit | integer <int32> Maximal amount of items returned |
{- "$_type": "PersonPresenceQuery",
- "searchFilters": [
- {
- "$_type": "JoinedTimestampPersonPresenceSearchFilter",
- "field": "JOINED_TIMESTAMP",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
], - "orderBy": [
- {
- "$_type": "PersonPresenceOrderBy",
- "field": "CREATION_TIMESTAMP",
- "order": "ASCENDING"
}
], - "offset": 0,
- "limit": 0
}
$_type | string Default: "PersonPresenceResult" Value: "PersonPresenceResult" |
hasMoreItems | boolean Flag to indicate if there are more items on the server |
nextOffset | integer <int32> If more items are present on the server, this value can be used as offset in the next query |
Array of objects (PersonPresenceData) [ items ] The returned list of entities |
{- "$_type": "PersonPresenceResult",
- "hasMoreItems": true,
- "nextOffset": 0,
- "items": [
- {
- "$_type": "PersonPresenceData",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "accountId": "string",
- "joinedTimestamp": 0,
- "leftTimestamp": 0,
- "personId": "string",
- "deviceInfo": {
- "$_type": "DeviceInfo",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "accountId": "string",
- "osName": "string",
- "osVersion": "string",
- "browserName": "string",
- "browserVersion": "string",
- "userAgent": "string",
- "screenWidth": 0,
- "screenHeight": 0,
- "screenPixelRatio": 0,
- "type": "MOBILE",
- "identifier": "string",
- "identifierSource": "COOKIE",
- "pushToken": "string",
- "ownerPersonId": "string"
}, - "touchTimestamp": 0,
- "impersonationType": "NONE",
- "impersonatedFromUserId": "string",
- "impersonatedFromAccountId": "string",
- "additionalInfo": "string",
- "authInfo": "string",
- "propagated": true
}
]
}
$_type | string Default: "JoinedTimestampPersonPresenceSearchFilter" Value: "JoinedTimestampPersonPresenceSearchFilter" |
field | string (EPersonPresenceSearchFilterField) enum-descriptions: ["JOINED_TIMESTAMP: Filter by the 'joindTimestamp' attribute","LEFT_TIMESTAMP: Filter by the 'leftTimestamp' attribute","PERSON_ID: Filter by the 'personId' attribute"] JOINED_TIMESTAMP JOINED_TIMESTAMP LEFT_TIMESTAMP PERSON_ID |
any (TimestampOperator) |
{- "$_type": "JoinedTimestampPersonPresenceSearchFilter",
- "field": "JOINED_TIMESTAMP",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
$_type | string Default: "PersonQuery" Value: "PersonQuery" |
Array of any (PersonSearchFilter) [ items ] List of filters to narrow the search of entities | |
Array of objects (PersonOrderBy) [ items ] List of criteria to order the search result list | |
offset | integer <int32> Offset position in the result set to start pagination |
limit | integer <int32> Maximal amount of items returned |
{- "$_type": "PersonQuery",
- "searchFilters": [
- {
- "$_type": "AuthorizationRolePersonSearchFilter",
- "field": "PERSON_SOURCE",
- "operator": {
- "$_type": "EqualsAuthorizationRoleOperator",
- "type": "EQUALS",
- "value": "SUPER_ADMIN"
}
}
], - "orderBy": [
- {
- "$_type": "PersonOrderBy",
- "field": "ID",
- "order": "ASCENDING"
}
], - "offset": 0,
- "limit": 0
}
$_type | string Default: "PersonResult" Value: "PersonResult" |
hasMoreItems | boolean Flag to indicate if there are more items on the server |
nextOffset | integer <int32> If more items are present on the server, this value can be used as offset in the next query |
Array of objects (PersonData) [ items ] The returned list of entities |
{- "$_type": "PersonResult",
- "hasMoreItems": true,
- "nextOffset": 0,
- "items": [
- {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}
]
}
$_type | string Default: "AuthorizationRolePersonSearchFilter" Value: "AuthorizationRolePersonSearchFilter" |
field | string (EPersonSearchFilterField) enum-descriptions: ["PERSON_SOURCE: Filter by the 'personSource' attribute","SOURCE_ID: Filter by the 'sourceId' attribute","SOURCE_DATA: Filter by the 'sourceData' attribute","FIRST_NAME: Filter by the 'firstName' attribute","LAST_NAME: Filter by the 'lastName' attribute","USERNAME: Filter by the 'username' attribute","NICKNAME: Filter by the 'nickname' attribute","PERSON_TYPE: Filter by the 'personType' attribute","AUTHORIZATION_ROLE: Filter by the 'authorizationRole' attribute","EMAIL: Filter by the 'email' attribute","PHONE: Filter by the 'phone' attribute","TEAM_ID: Filter by the 'teamId' attribute"] AUTHORIZATION_ROLE PERSON_SOURCE SOURCE_ID SOURCE_DATA FIRST_NAME LAST_NAME USERNAME NICKNAME PERSON_TYPE AUTHORIZATION_ROLE EMAIL PHONE TEAM_ID |
any (AuthorizationRoleOperator) |
{- "$_type": "AuthorizationRolePersonSearchFilter",
- "field": "AUTHORIZATION_ROLE",
- "operator": {
- "$_type": "EqualsAuthorizationRoleOperator",
- "type": "EQUALS",
- "value": "SUPER_ADMIN"
}
}
$_type | string Default: "EqualsPersonSourceOperator" Value: "EqualsPersonSourceOperator" |
type | string (EPersonSourceOperatorType) enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator"] EQUALS EQUALS NOT_EQUALS IN NOT_IN |
value | string (EPersonSource) Enum: "USER_DB" "VIRTUAL" enum-descriptions: ["USER_DB: Person-Source is on the main_user table","VIRTUAL: Person-Source is only virtual (no seperate storage)"] The source type of a person (participant of a conversation) |
{- "$_type": "EqualsPersonSourceOperator",
- "type": "EQUALS",
- "value": "USER_DB"
}
$_type | string Default: "PersonSourcePersonSearchFilter" Value: "PersonSourcePersonSearchFilter" |
field | string (EPersonSearchFilterField) Enum: "PERSON_SOURCE" "SOURCE_ID" "SOURCE_DATA" "FIRST_NAME" "LAST_NAME" "USERNAME" "NICKNAME" "PERSON_TYPE" "AUTHORIZATION_ROLE" "EMAIL" "PHONE" "TEAM_ID" enum-descriptions: ["PERSON_SOURCE: Filter by the 'personSource' attribute","SOURCE_ID: Filter by the 'sourceId' attribute","SOURCE_DATA: Filter by the 'sourceData' attribute","FIRST_NAME: Filter by the 'firstName' attribute","LAST_NAME: Filter by the 'lastName' attribute","USERNAME: Filter by the 'username' attribute","NICKNAME: Filter by the 'nickname' attribute","PERSON_TYPE: Filter by the 'personType' attribute","AUTHORIZATION_ROLE: Filter by the 'authorizationRole' attribute","EMAIL: Filter by the 'email' attribute","PHONE: Filter by the 'phone' attribute","TEAM_ID: Filter by the 'teamId' attribute"] |
any (PersonSourceOperator) |
{- "$_type": "PersonSourcePersonSearchFilter",
- "field": "PERSON_SOURCE",
- "operator": {
- "$_type": "EqualsPersonSourceOperator",
- "type": "EQUALS",
- "value": "USER_DB"
}
}
$_type | string Default: "EqualsPersonTypeOperator" Value: "EqualsPersonTypeOperator" |
type | string (EPersonTypeOperatorType) enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator"] EQUALS EQUALS NOT_EQUALS IN NOT_IN |
value | string (EPersonType) Enum: "AGENT" "VISITOR" "SYSTEM" "BOT" enum-descriptions: ["AGENT: Agent participant","VISITOR: Visitor participant","SYSTEM: System participant","BOT: Bot participant"] The type of a person (participant of a session) |
{- "$_type": "EqualsPersonTypeOperator",
- "type": "EQUALS",
- "value": "AGENT"
}
$_type | string Default: "PersonTypePersonSearchFilter" Value: "PersonTypePersonSearchFilter" |
field | string (EPersonSearchFilterField) Enum: "PERSON_SOURCE" "SOURCE_ID" "SOURCE_DATA" "FIRST_NAME" "LAST_NAME" "USERNAME" "NICKNAME" "PERSON_TYPE" "AUTHORIZATION_ROLE" "EMAIL" "PHONE" "TEAM_ID" enum-descriptions: ["PERSON_SOURCE: Filter by the 'personSource' attribute","SOURCE_ID: Filter by the 'sourceId' attribute","SOURCE_DATA: Filter by the 'sourceData' attribute","FIRST_NAME: Filter by the 'firstName' attribute","LAST_NAME: Filter by the 'lastName' attribute","USERNAME: Filter by the 'username' attribute","NICKNAME: Filter by the 'nickname' attribute","PERSON_TYPE: Filter by the 'personType' attribute","AUTHORIZATION_ROLE: Filter by the 'authorizationRole' attribute","EMAIL: Filter by the 'email' attribute","PHONE: Filter by the 'phone' attribute","TEAM_ID: Filter by the 'teamId' attribute"] |
any (PersonTypeOperator) |
{- "$_type": "PersonTypePersonSearchFilter",
- "field": "PERSON_SOURCE",
- "operator": {
- "$_type": "EqualsPersonTypeOperator",
- "type": "EQUALS",
- "value": "AGENT"
}
}
$_type | string Default: "PhonePersonSearchFilter" Value: "PhonePersonSearchFilter" |
field | string (EPersonSearchFilterField) Enum: "PERSON_SOURCE" "SOURCE_ID" "SOURCE_DATA" "FIRST_NAME" "LAST_NAME" "USERNAME" "NICKNAME" "PERSON_TYPE" "AUTHORIZATION_ROLE" "EMAIL" "PHONE" "TEAM_ID" enum-descriptions: ["PERSON_SOURCE: Filter by the 'personSource' attribute","SOURCE_ID: Filter by the 'sourceId' attribute","SOURCE_DATA: Filter by the 'sourceData' attribute","FIRST_NAME: Filter by the 'firstName' attribute","LAST_NAME: Filter by the 'lastName' attribute","USERNAME: Filter by the 'username' attribute","NICKNAME: Filter by the 'nickname' attribute","PERSON_TYPE: Filter by the 'personType' attribute","AUTHORIZATION_ROLE: Filter by the 'authorizationRole' attribute","EMAIL: Filter by the 'email' attribute","PHONE: Filter by the 'phone' attribute","TEAM_ID: Filter by the 'teamId' attribute"] |
any (StringOperator) |
{- "$_type": "PhonePersonSearchFilter",
- "field": "PERSON_SOURCE",
- "operator": {
- "$_type": "EqualsStringOperator",
- "type": "EQUALS",
- "value": "string"
}
}
$_type | string Default: "PinCreatedEvent" Value: "PinCreatedEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
invitationId | string Id of the invitation |
conversationId | string Id of the conversation |
token | string Token (digits for pin or character sequence) requested to redeem or revoke the invitation |
dateCreated | integer <int64> Unix timestamp when the event was created |
creatorType | string (EInvitationCreatorType) Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR" enum-descriptions: ["WEB_API: Invitation created with the API","SYSTEM: Invitation created by the system","AGENT: Invitation created by an agent","VISITOR: Invitation created by a visitor"] The type of the person/system who created an invitation |
object (PersonData) Representation of a Person (Agent or Visitor). | |
expirationTimestamp | integer <int64> Unix timestamp after witch the invitation is no longer valid |
Array of objects (ConversationLink) [ items ] List of links that can be used to accept the pin event with the token. |
{- "$_type": "PinCreatedEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "invitationId": "string",
- "conversationId": "string",
- "token": "string",
- "dateCreated": 0,
- "creatorType": "WEB_API",
- "creatorPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "expirationTimestamp": 0,
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
]
}
$_type | string Default: "PinRedeemedEvent" Value: "PinRedeemedEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
invitationId | string Id of the invitation |
conversationId | string Id of the conversation |
token | string Token (digits for pin or character sequence) requested to redeem or revoke the invitation |
dateCreated | integer <int64> Unix timestamp when the event was created |
creatorType | string (EInvitationCreatorType) Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR" enum-descriptions: ["WEB_API: Invitation created with the API","SYSTEM: Invitation created by the system","AGENT: Invitation created by an agent","VISITOR: Invitation created by a visitor"] The type of the person/system who created an invitation |
object (PersonData) Representation of a Person (Agent or Visitor). | |
expirationTimestamp | integer <int64> Unix timestamp after witch the invitation is no longer valid |
object (PersonData) Representation of a Person (Agent or Visitor). |
{- "$_type": "PinRedeemedEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "invitationId": "string",
- "conversationId": "string",
- "token": "string",
- "dateCreated": 0,
- "creatorType": "WEB_API",
- "creatorPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "expirationTimestamp": 0,
- "redeemingPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}
}
$_type | string Default: "PinRenewedEvent" Value: "PinRenewedEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
invitationId | string Id of the invitation |
conversationId | string Id of the conversation |
token | string Token (digits for pin or character sequence) requested to redeem or revoke the invitation |
dateCreated | integer <int64> Unix timestamp when the event was created |
creatorType | string (EInvitationCreatorType) Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR" enum-descriptions: ["WEB_API: Invitation created with the API","SYSTEM: Invitation created by the system","AGENT: Invitation created by an agent","VISITOR: Invitation created by a visitor"] The type of the person/system who created an invitation |
object (PersonData) Representation of a Person (Agent or Visitor). | |
expirationTimestamp | integer <int64> Unix timestamp after witch the invitation is no longer valid |
Array of objects (ConversationLink) [ items ] List of links that can be used to accept the visitor invitation event with the token. |
{- "$_type": "PinRenewedEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "invitationId": "string",
- "conversationId": "string",
- "token": "string",
- "dateCreated": 0,
- "creatorType": "WEB_API",
- "creatorPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "expirationTimestamp": 0,
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
]
}
$_type | string Default: "PinRevokedEvent" Value: "PinRevokedEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
invitationId | string Id of the invitation |
conversationId | string Id of the conversation |
token | string Token (digits for pin or character sequence) requested to redeem or revoke the invitation |
dateCreated | integer <int64> Unix timestamp when the event was created |
creatorType | string (EInvitationCreatorType) Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR" enum-descriptions: ["WEB_API: Invitation created with the API","SYSTEM: Invitation created by the system","AGENT: Invitation created by an agent","VISITOR: Invitation created by a visitor"] The type of the person/system who created an invitation |
object (PersonData) Representation of a Person (Agent or Visitor). | |
expirationTimestamp | integer <int64> Unix timestamp after witch the invitation is no longer valid |
{- "$_type": "PinRevokedEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "invitationId": "string",
- "conversationId": "string",
- "token": "string",
- "dateCreated": 0,
- "creatorType": "WEB_API",
- "creatorPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "expirationTimestamp": 0
}
$_type | string Default: "PostListMessageCardItemData" Value: "PostListMessageCardItemData" |
imageUrl | string URL of the image displayed at the top of the card. (optional)
|
imageAltText | string Alt text for the image. (required if imageUrl is set) |
title | string Title displayed below the image. (optional) Max length is 64 characters. |
body | string Body text which may optionally contain markdown. (optional) Max length is 256 characters. |
bodyTextType | string (EConversationMessageTextType) Enum: "SIMPLE_TEXT" "MARKDOWN" enum-descriptions: ["SIMPLE_TEXT: Text will be interpreted as simple text. <p> Auto link detection will still be possible.","MARKDOWN: Text will be interpreted as Markdown. <p> The supported Markdown subset depends on the message type."] How text in a conversation message should be interpreted. |
object (MessageAction) Message action used in card and list messages. Reply actions are displayed as buttons whereas internal and external links are rendered as links. |
{- "$_type": "PostListMessageCardItemData",
- "imageUrl": "string",
- "imageAltText": "string",
- "title": "string",
- "body": "string",
- "bodyTextType": "SIMPLE_TEXT",
- "action": {
- "$_type": "MessageAction",
- "actionType": "LINK_INTERNAL",
- "label": "string",
- "value": "string"
}
}
$_type | string Default: "CardPostMessageData" Value: "CardPostMessageData" |
type | string (EPostMessageType) enum-descriptions: ["TEXT: See `TextPostMessageData`","FILE: See `FilePostMessageData`","CARD: See `CardPostMessageData`","LIST: See `ListPostMessageData`","MULTICHOICE_QUESTION: See `MultichoiceQuestionPostMessageData`","RATING_QUESTION: See `RatingQuestionPostMessageData`","TEXT_QUESTION: See `TextQuestionPostMessageData`","REPLY: See `ReplyPostMessageData`"] Type of a message which is send to the collaboration server CARD TEXT FILE CARD LIST MULTICHOICE_QUESTION RATING_QUESTION TEXT_QUESTION REPLY |
fallbackText | string Optional fallback text which is used when:
The value must not contain markdown. If no fallback is given, a fallback text based on the content of the message is generated. This may however not always be a perfect textual representation of the message. |
imageUrl | string URL of the image displayed at the top of the card. (optional)
|
imageAltText | string Alt text for the image. (required if imageUrl is set) |
title | string Title displayed below the image. (optional) Max length is 64 characters. |
body | string Body text which may optionally contain markdown. (optional) Max length is 640 characters. |
bodyTextType | string (EConversationMessageTextType) Enum: "SIMPLE_TEXT" "MARKDOWN" enum-descriptions: ["SIMPLE_TEXT: Text will be interpreted as simple text. <p> Auto link detection will still be possible.","MARKDOWN: Text will be interpreted as Markdown. <p> The supported Markdown subset depends on the message type."] How text in a conversation message should be interpreted. |
Array of objects (MessageAction) [ items ] Actions which will be displayed at the bottom of the card. (optional) Max number of actions is 5. | |
Array of objects (QuickReply) [ items ] Optional list of quick replies available to the message's recipients Max number of quick replies is 13. |
{- "$_type": "CardPostMessageData",
- "type": "CARD",
- "fallbackText": "string",
- "imageUrl": "string",
- "imageAltText": "string",
- "title": "string",
- "body": "string",
- "bodyTextType": "SIMPLE_TEXT",
- "actions": [
- {
- "$_type": "MessageAction",
- "actionType": "LINK_INTERNAL",
- "label": "string",
- "value": "string"
}
], - "quickReplies": [
- {
- "$_type": "QuickReply",
- "text": "string"
}
]
}
$_type | string Default: "ProductVersion" Value: "ProductVersion" |
productVersion | string The version of the product |
productGuid | string The unique identifier of the product build |
{- "$_type": "ProductVersion",
- "productVersion": "string",
- "productGuid": "string"
}
$_type | string Default: "QueryParameter" Value: "QueryParameter" |
documentation | string Documentation of the query parameter |
name | string Name of the query parameter |
type | string Type of the query parameter |
{- "$_type": "QueryParameter",
- "documentation": "string",
- "name": "string",
- "type": "string"
}
$_type | string Default: "QuestionAbortedMessageData" Value: "QuestionAbortedMessageData" |
id | string The ID of the message. |
conversationId | string Conversation ID to which this message belongs to |
externalMessengerChannelId | string ID of the external messenger channel connected to the conversation. Null if the conversation is not connected to an external messenger. |
accountId | string Account ID to which this message and conversation belongs to. |
object (PersonData) Representation of a Person (Agent or Visitor). | |
senderPersonPresenceId | string Id of the person presence that sends the message. May be null if the message was sent by the system. |
serverTimestamp | integer <int64> utc timestamp when the message was received on the server. |
sendTimestamp | integer <int64> utc timestamp when the message was sent from the client |
type | string (EMessageType) Enum: "TEXT" "FILE" "CARD" "LIST" "APPROVAL_REQUEST" "MULTICHOICE_QUESTION" "RATING_QUESTION" "TEXT_QUESTION" "REPLY" "QUESTION_ABORTED" enum-descriptions: ["TEXT","FILE","CARD","LIST","APPROVAL_REQUEST","MULTICHOICE_QUESTION","RATING_QUESTION","TEXT_QUESTION","REPLY","QUESTION_ABORTED"] The message type of a conversation message |
recipientPersonIds | Array of strings Person IDs of the recipients of the message. If it is null, all active participations are recipients |
fallbackText | string Text representation of the message which is used in following cases:
The fallback text can be provided by the sender (bot, external messenger) or is generated when missing. This may however not always be a perfect textual representation of the message. |
actionId | string An ID of the action triggering the message to be able to identify a message created by an action. |
sourceId | string A custom ID which identifies where this message initially came from. |
questionMessageId | string ID of the question message for which this reply is |
value | string The reply value for the question message. |
reason | string (EQuestionMessageAbortReason) Enum: "TIMEDOUT" "CANCELED" enum-descriptions: ["TIMEDOUT: A person was to slow to answer a message","CANCELED: The question was canceled explicitly by the system, a bot or an external messenger channel"] Reason why a question message was not answered |
{- "$_type": "QuestionAbortedMessageData",
- "id": "string",
- "conversationId": "string",
- "externalMessengerChannelId": "string",
- "accountId": "string",
- "senderPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "senderPersonPresenceId": "string",
- "serverTimestamp": 0,
- "sendTimestamp": 0,
- "type": "TEXT",
- "recipientPersonIds": [
- "string"
], - "fallbackText": "string",
- "actionId": "string",
- "sourceId": "string",
- "questionMessageId": "string",
- "value": "string",
- "reason": "TIMEDOUT"
}
$_type | string Default: "QuickReply" Value: "QuickReply" |
text | string Quick reply text displayed as button available to the message's recipient. Simple text, max 40 characters. |
{- "$_type": "QuickReply",
- "text": "string"
}
$_type | string Default: "RatingQuestionMessageData" Value: "RatingQuestionMessageData" |
id | string The ID of the message. |
conversationId | string Conversation ID to which this message belongs to |
externalMessengerChannelId | string ID of the external messenger channel connected to the conversation. Null if the conversation is not connected to an external messenger. |
accountId | string Account ID to which this message and conversation belongs to. |
object (PersonData) Representation of a Person (Agent or Visitor). | |
senderPersonPresenceId | string Id of the person presence that sends the message. May be null if the message was sent by the system. |
serverTimestamp | integer <int64> utc timestamp when the message was received on the server. |
sendTimestamp | integer <int64> utc timestamp when the message was sent from the client |
type | string (EMessageType) Enum: "TEXT" "FILE" "CARD" "LIST" "APPROVAL_REQUEST" "MULTICHOICE_QUESTION" "RATING_QUESTION" "TEXT_QUESTION" "REPLY" "QUESTION_ABORTED" enum-descriptions: ["TEXT","FILE","CARD","LIST","APPROVAL_REQUEST","MULTICHOICE_QUESTION","RATING_QUESTION","TEXT_QUESTION","REPLY","QUESTION_ABORTED"] The message type of a conversation message |
recipientPersonIds | Array of strings Person IDs of the recipients of the message. If it is null, all active participations are recipients |
fallbackText | string Text representation of the message which is used in following cases:
The fallback text can be provided by the sender (bot, external messenger) or is generated when missing. This may however not always be a perfect textual representation of the message. |
actionId | string An ID of the action triggering the message to be able to identify a message created by an action. |
sourceId | string A custom ID which identifies where this message initially came from. |
text | string Text of the message |
textType | string (EConversationMessageTextType) Enum: "SIMPLE_TEXT" "MARKDOWN" enum-descriptions: ["SIMPLE_TEXT: Text will be interpreted as simple text. <p> Auto link detection will still be possible.","MARKDOWN: Text will be interpreted as Markdown. <p> The supported Markdown subset depends on the message type."] How text in a conversation message should be interpreted. |
Array of objects (RatingQuestionOption) [ items ] Response options for the question. | |
answerStatus | string (EAnswerStatus) Enum: "PENDING" "ANSWERED" "TIMEDOUT" "CANCELED" enum-descriptions: ["PENDING: Question is not answered yet","ANSWERED: Question was successfully answered","TIMEDOUT: Question was running into a timeout","CANCELED: Question was canceled by the system, a bot or an external messenger channel"] The state of a question message |
declinable | boolean Whether the question can be declined |
declineLabel | string Label for the decline button which will also be used as text for the reply |
declineValue | string Value which will be propagated as reply value if the question is declined |
{- "$_type": "RatingQuestionMessageData",
- "id": "string",
- "conversationId": "string",
- "externalMessengerChannelId": "string",
- "accountId": "string",
- "senderPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "senderPersonPresenceId": "string",
- "serverTimestamp": 0,
- "sendTimestamp": 0,
- "type": "TEXT",
- "recipientPersonIds": [
- "string"
], - "fallbackText": "string",
- "actionId": "string",
- "sourceId": "string",
- "text": "string",
- "textType": "SIMPLE_TEXT",
- "options": [
- {
- "$_type": "RatingQuestionOption",
- "label": "string",
- "value": "string"
}
], - "answerStatus": "PENDING",
- "declinable": true,
- "declineLabel": "string",
- "declineValue": "string"
}
$_type | string Default: "RatingQuestionOption" Value: "RatingQuestionOption" |
label | string Visual representation of the option |
value | string Value of the option, which is used in a |
{- "$_type": "RatingQuestionOption",
- "label": "string",
- "value": "string"
}
$_type | string Default: "RatingQuestionPostMessageData" Value: "RatingQuestionPostMessageData" |
type | string (EPostMessageType) Enum: "TEXT" "FILE" "CARD" "LIST" "MULTICHOICE_QUESTION" "RATING_QUESTION" "TEXT_QUESTION" "REPLY" enum-descriptions: ["TEXT: See `TextPostMessageData`","FILE: See `FilePostMessageData`","CARD: See `CardPostMessageData`","LIST: See `ListPostMessageData`","MULTICHOICE_QUESTION: See `MultichoiceQuestionPostMessageData`","RATING_QUESTION: See `RatingQuestionPostMessageData`","TEXT_QUESTION: See `TextQuestionPostMessageData`","REPLY: See `ReplyPostMessageData`"] Type of a message which is send to the collaboration server |
fallbackText | string Optional fallback text which is used when:
The value must not contain markdown. If no fallback is given, a fallback text based on the content of the message is generated. This may however not always be a perfect textual representation of the message. |
text | string Question message text |
textType | string (EConversationMessageTextType) Enum: "SIMPLE_TEXT" "MARKDOWN" enum-descriptions: ["SIMPLE_TEXT: Text will be interpreted as simple text. <p> Auto link detection will still be possible.","MARKDOWN: Text will be interpreted as Markdown. <p> The supported Markdown subset depends on the message type."] How text in a conversation message should be interpreted. |
Array of objects (RatingQuestionOption) [ items ] Response options for the question. | |
declinable | boolean Whether the question can be declined |
declineLabel | string Label for the decline button which will also be used as text for the reply |
declineValue | string Value which will be propagated as reply value if the question is declined |
{- "$_type": "RatingQuestionPostMessageData",
- "type": "TEXT",
- "fallbackText": "string",
- "text": "string",
- "textType": "SIMPLE_TEXT",
- "options": [
- {
- "$_type": "RatingQuestionOption",
- "label": "string",
- "value": "string"
}
], - "declinable": true,
- "declineLabel": "string",
- "declineValue": "string"
}
$_type | string Default: "ReadMessagePushNotificationEvent" Value: "ReadMessagePushNotificationEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
object (PersonData) Representation of a Person (Agent or Visitor). | |
locale | string Locale (as BCP 47 language tag form including region if available) |
conversationId | string Id of the conversation |
deviceTokens | Array of strings List of device tokens |
messageId | string Id of the message |
readTimestamp | integer <int64> Timestamp when the message was read. |
notificationCount | integer <int32> Number of notifications (i.e. unread messages) in this conversation |
{- "$_type": "ReadMessagePushNotificationEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "recipient": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "locale": "string",
- "conversationId": "string",
- "deviceTokens": [
- "string"
], - "messageId": "string",
- "readTimestamp": 0,
- "notificationCount": 0
}
$_type | string Default: "RecipientIdConversationSearchFilter" Value: "RecipientIdConversationSearchFilter" |
field | string (EConversationSearchFilterField) Enum: "CREATION_TIMESTAMP" "END_TIMESTAMP" "INITIAL_ENGAGEMENT_TYPE" "TOPIC" "CONTEXT_PERSON_ID" "ASSIGNEE_PERSON_ID" "PARTICIPANT_PERSON_ID" "STATE" "END_REASON" "CONVERSATION_TEMPLATE_ID" "RECIPIENT_ID" "RECIPIENT_TYPE" "TOKBOX_SESSION_ID" enum-descriptions: ["CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","END_TIMESTAMP: Filter by the 'endTimestamp' attribute","INITIAL_ENGAGEMENT_TYPE: Filter by the 'initialEngagementType' attribute","TOPIC: Filter by the 'topic' attribute","CONTEXT_PERSON_ID: Filter by the 'contextPersonId' attribute","ASSIGNEE_PERSON_ID: Filter by the 'assigneePersonId' attribute","PARTICIPANT_PERSON_ID: Filter by the 'personId' of the participants","STATE: Filter by the 'state' attribute","END_REASON: Filter by the 'endReason' attribute","CONVERSATION_TEMPLATE_ID: Filter by the 'conversationTemplateId' attribute","RECIPIENT_ID: Filter by the 'id' of the 'recipient' attribute","RECIPIENT_TYPE: Filter by the 'type' of the 'recipient' attribute","TOKBOX_SESSION_ID: Filter by the 'tokboxSessionId' attribute"] |
any (IdOperator) Defines operators used for comparing id fields in tables. |
{- "$_type": "RecipientIdConversationSearchFilter",
- "field": "CREATION_TIMESTAMP",
- "operator": {
- "$_type": "EqualsIdOperator",
- "type": "EQUALS",
- "value": "string"
}
}
$_type | string Default: "RecipientTypeConversationSearchFilter" Value: "RecipientTypeConversationSearchFilter" |
field | string (EConversationSearchFilterField) Enum: "CREATION_TIMESTAMP" "END_TIMESTAMP" "INITIAL_ENGAGEMENT_TYPE" "TOPIC" "CONTEXT_PERSON_ID" "ASSIGNEE_PERSON_ID" "PARTICIPANT_PERSON_ID" "STATE" "END_REASON" "CONVERSATION_TEMPLATE_ID" "RECIPIENT_ID" "RECIPIENT_TYPE" "TOKBOX_SESSION_ID" enum-descriptions: ["CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","END_TIMESTAMP: Filter by the 'endTimestamp' attribute","INITIAL_ENGAGEMENT_TYPE: Filter by the 'initialEngagementType' attribute","TOPIC: Filter by the 'topic' attribute","CONTEXT_PERSON_ID: Filter by the 'contextPersonId' attribute","ASSIGNEE_PERSON_ID: Filter by the 'assigneePersonId' attribute","PARTICIPANT_PERSON_ID: Filter by the 'personId' of the participants","STATE: Filter by the 'state' attribute","END_REASON: Filter by the 'endReason' attribute","CONVERSATION_TEMPLATE_ID: Filter by the 'conversationTemplateId' attribute","RECIPIENT_ID: Filter by the 'id' of the 'recipient' attribute","RECIPIENT_TYPE: Filter by the 'type' of the 'recipient' attribute","TOKBOX_SESSION_ID: Filter by the 'tokboxSessionId' attribute"] |
any (ConversationRecipientTypeOperator) |
{- "$_type": "RecipientTypeConversationSearchFilter",
- "field": "CREATION_TIMESTAMP",
- "operator": {
- "$_type": "EqualsConversationRecipientTypeOperator",
- "type": "EQUALS",
- "value": "AGENT"
}
}
$_type | string Default: "RedeemingPersonIdConversationInvitationSearchFilter" Value: "RedeemingPersonIdConversationInvitationSearchFilter" |
field | string (EConversationInvitationSearchFilterField) Enum: "INVITATION_TYPE" "TARGET_TYPE" "CONVERSATION_ID" "TARGET_ID" "EXPIRATION_TIMESTAMP" "CREATION_TIMESTAMP" "CREATOR_TYPE" "CREATOR_PERSON_ID" "REDEEMING_PERSON_ID" enum-descriptions: ["INVITATION_TYPE: Filter by the 'type' attribute","TARGET_TYPE: Filter by the 'targetType' attribute","CONVERSATION_ID: Filter by the 'conversationId' attribute","TARGET_ID: Filter by the 'targetId' attribute","EXPIRATION_TIMESTAMP: Filter by the 'expirationTimestamp' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","CREATOR_TYPE: Filter by the 'creatorType' attribute","CREATOR_PERSON_ID: Filter by the 'creatorId' attribute","REDEEMING_PERSON_ID: Filter by the 'redeemerPersonId' attribute"] |
any (IdOperator) Defines operators used for comparing id fields in tables. |
{- "$_type": "RedeemingPersonIdConversationInvitationSearchFilter",
- "field": "INVITATION_TYPE",
- "operator": {
- "$_type": "EqualsIdOperator",
- "type": "EQUALS",
- "value": "string"
}
}
$_type | string Default: "RegistrationIdNameWebhookCallLogSearchFilter" Value: "RegistrationIdNameWebhookCallLogSearchFilter" |
field | string (EWebhookCallLogSearchFilterField) Enum: "EVENT_NAME" "REGISTRATION_ID" "REQUEST_ID" "EXECUTION_TIMESTAMP" "ENDPOINT" "RETRY_NR" "CREATION_TIMESTAMP" "HTTP_RESPONSE_CODE" enum-descriptions: ["EVENT_NAME: Filter by the 'eventName' attribute","REGISTRATION_ID: Filter by the 'registrationId' attribute","REQUEST_ID: Filter by the 'requestId' attribute","EXECUTION_TIMESTAMP: Filter by the 'executionTimestamp' attribute","ENDPOINT: Filter by the 'endpoint' attribute","RETRY_NR: Filter by the 'retryNr' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","HTTP_RESPONSE_CODE: Filter by the 'httpResponseCode' attribute"] |
any (StringOperator) |
{- "$_type": "RegistrationIdNameWebhookCallLogSearchFilter",
- "field": "EVENT_NAME",
- "operator": {
- "$_type": "EqualsStringOperator",
- "type": "EQUALS",
- "value": "string"
}
}
$_type | string Default: "ReplyMessageData" Value: "ReplyMessageData" |
id | string The ID of the message. |
conversationId | string Conversation ID to which this message belongs to |
externalMessengerChannelId | string ID of the external messenger channel connected to the conversation. Null if the conversation is not connected to an external messenger. |
accountId | string Account ID to which this message and conversation belongs to. |
object (PersonData) Representation of a Person (Agent or Visitor). | |
senderPersonPresenceId | string Id of the person presence that sends the message. May be null if the message was sent by the system. |
serverTimestamp | integer <int64> utc timestamp when the message was received on the server. |
sendTimestamp | integer <int64> utc timestamp when the message was sent from the client |
type | string (EMessageType) Enum: "TEXT" "FILE" "CARD" "LIST" "APPROVAL_REQUEST" "MULTICHOICE_QUESTION" "RATING_QUESTION" "TEXT_QUESTION" "REPLY" "QUESTION_ABORTED" enum-descriptions: ["TEXT","FILE","CARD","LIST","APPROVAL_REQUEST","MULTICHOICE_QUESTION","RATING_QUESTION","TEXT_QUESTION","REPLY","QUESTION_ABORTED"] The message type of a conversation message |
recipientPersonIds | Array of strings Person IDs of the recipients of the message. If it is null, all active participations are recipients |
fallbackText | string Text representation of the message which is used in following cases:
The fallback text can be provided by the sender (bot, external messenger) or is generated when missing. This may however not always be a perfect textual representation of the message. |
actionId | string An ID of the action triggering the message to be able to identify a message created by an action. |
sourceId | string A custom ID which identifies where this message initially came from. |
questionMessageId | string ID of the question message for which this reply is |
value | string The reply value for the question message. |
{- "$_type": "ReplyMessageData",
- "id": "string",
- "conversationId": "string",
- "externalMessengerChannelId": "string",
- "accountId": "string",
- "senderPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "senderPersonPresenceId": "string",
- "serverTimestamp": 0,
- "sendTimestamp": 0,
- "type": "TEXT",
- "recipientPersonIds": [
- "string"
], - "fallbackText": "string",
- "actionId": "string",
- "sourceId": "string",
- "questionMessageId": "string",
- "value": "string"
}
$_type | string Default: "ReplyPostMessageData" Value: "ReplyPostMessageData" |
type | string (EPostMessageType) Enum: "TEXT" "FILE" "CARD" "LIST" "MULTICHOICE_QUESTION" "RATING_QUESTION" "TEXT_QUESTION" "REPLY" enum-descriptions: ["TEXT: See `TextPostMessageData`","FILE: See `FilePostMessageData`","CARD: See `CardPostMessageData`","LIST: See `ListPostMessageData`","MULTICHOICE_QUESTION: See `MultichoiceQuestionPostMessageData`","RATING_QUESTION: See `RatingQuestionPostMessageData`","TEXT_QUESTION: See `TextQuestionPostMessageData`","REPLY: See `ReplyPostMessageData`"] Type of a message which is send to the collaboration server |
fallbackText | string Optional fallback text which is used when:
The value must not contain markdown. If no fallback is given, a fallback text based on the content of the message is generated. This may however not always be a perfect textual representation of the message. |
questionMessageId | string ID of the question message for which this reply is |
value | string The reply value for the question message. |
{- "$_type": "ReplyPostMessageData",
- "type": "TEXT",
- "fallbackText": "string",
- "questionMessageId": "string",
- "value": "string"
}
$_type | string Default: "RequestIdNameWebhookCallLogSearchFilter" Value: "RequestIdNameWebhookCallLogSearchFilter" |
field | string (EWebhookCallLogSearchFilterField) Enum: "EVENT_NAME" "REGISTRATION_ID" "REQUEST_ID" "EXECUTION_TIMESTAMP" "ENDPOINT" "RETRY_NR" "CREATION_TIMESTAMP" "HTTP_RESPONSE_CODE" enum-descriptions: ["EVENT_NAME: Filter by the 'eventName' attribute","REGISTRATION_ID: Filter by the 'registrationId' attribute","REQUEST_ID: Filter by the 'requestId' attribute","EXECUTION_TIMESTAMP: Filter by the 'executionTimestamp' attribute","ENDPOINT: Filter by the 'endpoint' attribute","RETRY_NR: Filter by the 'retryNr' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","HTTP_RESPONSE_CODE: Filter by the 'httpResponseCode' attribute"] |
any (StringOperator) |
{- "$_type": "RequestIdNameWebhookCallLogSearchFilter",
- "field": "EVENT_NAME",
- "operator": {
- "$_type": "EqualsStringOperator",
- "type": "EQUALS",
- "value": "string"
}
}
$_type | string Default: "ResourceMetadata" Value: "ResourceMetadata" |
documentation | string Documentation of the resource |
requiredRole | Array of strings Role required to call the resource. One Of EAuthorizationRole |
requiredCallOrigin | string Origin required to call the resource. One of EOrigin |
Array of objects (ResourcePathElement) [ items ] path to the resource. For the url each path element can be separated by / | |
Array of objects (QueryParameter) [ items ] Query parameters for the call | |
any (IBody) Body representation of | |
returnDocumentation | string Documentation of the return value |
object (ServiceTypeBinding) Representation of type binding. It reference either to a | |
isGetAll | boolean Defines if the resource is a listing resource. In this case its call ends with a / (e.g. rest/v1/accounts/) |
methodType | string (EMethodType) Enum: "GET" "POST" "PUT" "DELETE" enum-descriptions: ["GET: GET request. No content body","POST: POST request. Content body is send","PUT: PUT request. Content body is send with updated data","DELETE: DELETE request. No content body"] Type of a HTTP method |
{- "$_type": "ResourceMetadata",
- "documentation": "string",
- "requiredRole": [
- "string"
], - "requiredCallOrigin": "string",
- "path": [
- {
- "$_type": "ResourcePathElement",
- "documentation": "string",
- "name": "string",
- "dynamic": true,
- "type": "string"
}
], - "queryParameters": [
- {
- "$_type": "QueryParameter",
- "documentation": "string",
- "name": "string",
- "type": "string"
}
], - "body": {
- "$_type": "BodyElement",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- {
- "$_type": "ServiceTypeBinding",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- { }
]
}
], - "name": "string",
- "documentation": "string"
}, - "returnDocumentation": "string",
- "returnType": {
- "$_type": "ServiceTypeBinding",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- { }
]
}, - "isGetAll": true,
- "methodType": "GET"
}
$_type | string Default: "ResourcePathElement" Value: "ResourcePathElement" |
documentation | string Documentation of the element |
name | string Name of the path element |
dynamic | boolean True if it is a variable part |
type | string Type of the element |
{- "$_type": "ResourcePathElement",
- "documentation": "string",
- "name": "string",
- "dynamic": true,
- "type": "string"
}
$_type | string Default: "RetryNrWebhookCallLogSearchFilter" Value: "RetryNrWebhookCallLogSearchFilter" |
field | string (EWebhookCallLogSearchFilterField) Enum: "EVENT_NAME" "REGISTRATION_ID" "REQUEST_ID" "EXECUTION_TIMESTAMP" "ENDPOINT" "RETRY_NR" "CREATION_TIMESTAMP" "HTTP_RESPONSE_CODE" enum-descriptions: ["EVENT_NAME: Filter by the 'eventName' attribute","REGISTRATION_ID: Filter by the 'registrationId' attribute","REQUEST_ID: Filter by the 'requestId' attribute","EXECUTION_TIMESTAMP: Filter by the 'executionTimestamp' attribute","ENDPOINT: Filter by the 'endpoint' attribute","RETRY_NR: Filter by the 'retryNr' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","HTTP_RESPONSE_CODE: Filter by the 'httpResponseCode' attribute"] |
any (LongOperator) |
{- "$_type": "RetryNrWebhookCallLogSearchFilter",
- "field": "EVENT_NAME",
- "operator": {
- "$_type": "EqualsLongOperator",
- "type": "EQUALS",
- "value": 0
}
}
$_type | string Default: "RevokeCallPushNotificationEvent" Value: "RevokeCallPushNotificationEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
object (PersonData) Representation of a Person (Agent or Visitor). | |
locale | string Locale (as BCP 47 language tag form including region if available) |
conversationId | string Id of the conversation |
deviceTokens | Array of strings List of device tokens |
callState | string (ECallState) Enum: "IDLE" "CALLING" "FORWARDING" "ACTIVE" enum-descriptions: ["IDLE: The call is not active (anymore)","CALLING: The call is ringing, nobody accepted it yet","FORWARDING: The call is ringing for the hidden agents of the conversation, after no visible agent has accepted the call","ACTIVE: The call is active"] State of the call |
{- "$_type": "RevokeCallPushNotificationEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "recipient": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "locale": "string",
- "conversationId": "string",
- "deviceTokens": [
- "string"
], - "callState": "IDLE"
}
$_type | string Default: "SecureTokenRequest" Value: "SecureTokenRequest" |
token | string |
type | string (ESecureTokenType) Enum: "JWT" "OIDC_ACCESS_TOKEN" enum-descriptions: ["JWT","OIDC_ACCESS_TOKEN"] Token type |
{- "$_type": "SecureTokenRequest",
- "token": "string",
- "type": "JWT"
}
$_type | string Default: "SendTimestampMessageSearchFilter" Value: "SendTimestampMessageSearchFilter" |
field | string (EMessageSearchFilterField) Value: "SEND_TIMESTAMP" enum-descriptions: ["SEND_TIMESTAMP: Filter by the 'sendTimestamp' attribute"] |
any (TimestampOperator) |
{- "$_type": "SendTimestampMessageSearchFilter",
- "field": "SEND_TIMESTAMP",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
$_type | string Default: "ServiceType" Value: "ServiceType" |
documentation | string Documentation of the type |
name | string The name of the type |
implementationName | string Name of the service inside unblu. Only needed to match references in documentation |
isEnum | boolean True if the type is an enum |
additionalExpandables | Array of strings Name of the properties that can be expanded to the type |
Array of objects (ServiceTypeProperty) [ items ] All properties of the type | |
Array of objects (ServiceTypeProperty) [ items ] Static properties of the type. Mainly used for enum constants | |
Array of objects (ServiceTypeBinding) [ items ] If this type is an interface, list of types that implement it. | |
discriminatorName | string If this type has multiple implementation types, name of the property that is used as discriminator between the concrete types |
{- "$_type": "ServiceType",
- "documentation": "string",
- "name": "string",
- "implementationName": "string",
- "isEnum": true,
- "additionalExpandables": [
- "string"
], - "properties": [
- {
- "$_type": "ServiceTypeProperty",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- {
- "$_type": "ServiceTypeBinding",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- { }
]
}
], - "documentation": "string",
- "name": "string",
- "expandableType": "string"
}
], - "staticProperties": [
- {
- "$_type": "ServiceTypeProperty",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- {
- "$_type": "ServiceTypeBinding",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- { }
]
}
], - "documentation": "string",
- "name": "string",
- "expandableType": "string"
}
], - "implementationTypes": [
- {
- "$_type": "ServiceTypeBinding",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- { }
]
}
], - "discriminatorName": "string"
}
$_type | string Default: "ServiceTypeBinding" Value: "ServiceTypeBinding" |
typeName | string Name of the type |
isArray | boolean True if the type is an array |
numArrayDim | integer <int32> 0 if type is not an array. Otherwise the property defines the number of dimension of the property. E.g. with 2 a string type would be a 2 dim string array: string[][] |
isEnum | boolean True if the type is an enum |
Array of objects (ServiceTypeBinding) [ items ] Type arguments for generic types. E.g. a list has generic types: list<string> generic type would be string |
{- "$_type": "ServiceTypeBinding",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- { }
]
}
$_type | string Default: "ServiceTypeProperty" Value: "ServiceTypeProperty" |
typeName | string Name of the type |
isArray | boolean True if the type is an array |
numArrayDim | integer <int32> 0 if type is not an array. Otherwise the property defines the number of dimension of the property. E.g. with 2 a string type would be a 2 dim string array: string[][] |
isEnum | boolean True if the type is an enum |
Array of objects (ServiceTypeBinding) [ items ] Type arguments for generic types. E.g. a list has generic types: list<string> generic type would be string | |
documentation | string Documentation of the property |
name | string name of the property |
expandableType | string type if this property represent an id that can be expanded |
{- "$_type": "ServiceTypeProperty",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- {
- "$_type": "ServiceTypeBinding",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- { }
]
}
], - "documentation": "string",
- "name": "string",
- "expandableType": "string"
}
$_type | string Default: "ServiceWebhookEventType" Value: "ServiceWebhookEventType" |
documentation | string Documentation of the webhook event |
name | string Name of the event |
implementationName | string Name of the service inside unblu. Only needed to match references in documentation |
registrationLocation | string (ERegistrationLocation) Enum: "WEBHOOK_REGISTRATION" "BOT" "EXTERNAL_MESSENGER" enum-descriptions: ["WEBHOOK_REGISTRATION","BOT","EXTERNAL_MESSENGER"] Location where a webhook event can be registered. |
since | string (EWebApiVersion) Enum: "V1" "V2" "V3" enum-descriptions: ["V1: Version 1 of the Web-API. Introduced with Unblu 4.x.","V2: Version 2 of the Web-API. Introduced with Unblu 5.","V3: Version 3 of the Web-API. Introduced with Unblu 6."] Version of the Web-API. Version of API corresponds to a path element of the request URL. E.g.: /rest/v3/<service>/... |
Array of objects (ServiceTypeProperty) [ items ] Properties of the event | |
Array of objects (ServiceTypeProperty) [ items ] Static properties of the event. They are not send |
{- "$_type": "ServiceWebhookEventType",
- "documentation": "string",
- "name": "string",
- "implementationName": "string",
- "registrationLocation": "WEBHOOK_REGISTRATION",
- "since": "V1",
- "properties": [
- {
- "$_type": "ServiceTypeProperty",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- {
- "$_type": "ServiceTypeBinding",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- { }
]
}
], - "documentation": "string",
- "name": "string",
- "expandableType": "string"
}
], - "staticProperties": [
- {
- "$_type": "ServiceTypeProperty",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- {
- "$_type": "ServiceTypeBinding",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- { }
]
}
], - "documentation": "string",
- "name": "string",
- "expandableType": "string"
}
]
}
$_type | string Default: "ServicesContainer" Value: "ServicesContainer" |
version | string Version of the metadata |
Array of objects (WebApiService) [ items ] All services | |
Array of objects (ServiceWebhookEventType) [ items ] All webhook events | |
Array of objects (ServiceType) [ items ] All types used in the services and webhook events |
{- "$_type": "ServicesContainer",
- "version": "string",
- "services": [
- {
- "$_type": "WebApiService",
- "documentation": "string",
- "name": "string",
- "implementationName": "string",
- "resources": [
- {
- "$_type": "ResourceMetadata",
- "documentation": "string",
- "requiredRole": [
- "string"
], - "requiredCallOrigin": "string",
- "path": [
- {
- "$_type": "ResourcePathElement",
- "documentation": "string",
- "name": "string",
- "dynamic": true,
- "type": "string"
}
], - "queryParameters": [
- {
- "$_type": "QueryParameter",
- "documentation": "string",
- "name": "string",
- "type": "string"
}
], - "body": {
- "$_type": "BodyElement",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- {
- "$_type": "ServiceTypeBinding",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- { }
]
}
], - "name": "string",
- "documentation": "string"
}, - "returnDocumentation": "string",
- "returnType": {
- "$_type": "ServiceTypeBinding",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- { }
]
}, - "isGetAll": true,
- "methodType": "GET"
}
]
}
], - "webhookEvents": [
- {
- "$_type": "ServiceWebhookEventType",
- "documentation": "string",
- "name": "string",
- "implementationName": "string",
- "registrationLocation": "WEBHOOK_REGISTRATION",
- "since": "V1",
- "properties": [
- {
- "$_type": "ServiceTypeProperty",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- {
- "$_type": "ServiceTypeBinding",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- { }
]
}
], - "documentation": "string",
- "name": "string",
- "expandableType": "string"
}
], - "staticProperties": [
- {
- "$_type": "ServiceTypeProperty",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- {
- "$_type": "ServiceTypeBinding",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- { }
]
}
], - "documentation": "string",
- "name": "string",
- "expandableType": "string"
}
]
}
], - "types": [
- {
- "$_type": "ServiceType",
- "documentation": "string",
- "name": "string",
- "implementationName": "string",
- "isEnum": true,
- "additionalExpandables": [
- "string"
], - "properties": [
- {
- "$_type": "ServiceTypeProperty",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- {
- "$_type": "ServiceTypeBinding",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- { }
]
}
], - "documentation": "string",
- "name": "string",
- "expandableType": "string"
}
], - "staticProperties": [
- {
- "$_type": "ServiceTypeProperty",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- {
- "$_type": "ServiceTypeBinding",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- { }
]
}
], - "documentation": "string",
- "name": "string",
- "expandableType": "string"
}
], - "implementationTypes": [
- {
- "$_type": "ServiceTypeBinding",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- { }
]
}
], - "discriminatorName": "string"
}
]
}
$_type | string Default: "SiteIdNamedAreaSearchFilter" Value: "SiteIdNamedAreaSearchFilter" |
field | string (ENamedAreaSearchFilterField) Enum: "NAME" "DESCRIPTION" "SITE_ID" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["NAME: Filter by the 'name' attribute","DESCRIPTION: Filter by the 'description' attribute","SITE_ID: Filter by the 'siteId' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] |
any (StringOperator) |
{- "$_type": "SiteIdNamedAreaSearchFilter",
- "field": "NAME",
- "operator": {
- "$_type": "EqualsStringOperator",
- "type": "EQUALS",
- "value": "string"
}
}
$_type | string Default: "SourceDataPersonSearchFilter" Value: "SourceDataPersonSearchFilter" |
field | string (EPersonSearchFilterField) Enum: "PERSON_SOURCE" "SOURCE_ID" "SOURCE_DATA" "FIRST_NAME" "LAST_NAME" "USERNAME" "NICKNAME" "PERSON_TYPE" "AUTHORIZATION_ROLE" "EMAIL" "PHONE" "TEAM_ID" enum-descriptions: ["PERSON_SOURCE: Filter by the 'personSource' attribute","SOURCE_ID: Filter by the 'sourceId' attribute","SOURCE_DATA: Filter by the 'sourceData' attribute","FIRST_NAME: Filter by the 'firstName' attribute","LAST_NAME: Filter by the 'lastName' attribute","USERNAME: Filter by the 'username' attribute","NICKNAME: Filter by the 'nickname' attribute","PERSON_TYPE: Filter by the 'personType' attribute","AUTHORIZATION_ROLE: Filter by the 'authorizationRole' attribute","EMAIL: Filter by the 'email' attribute","PHONE: Filter by the 'phone' attribute","TEAM_ID: Filter by the 'teamId' attribute"] |
any (StringOperator) |
{- "$_type": "SourceDataPersonSearchFilter",
- "field": "PERSON_SOURCE",
- "operator": {
- "$_type": "EqualsStringOperator",
- "type": "EQUALS",
- "value": "string"
}
}
$_type | string Default: "SourceIdPersonSearchFilter" Value: "SourceIdPersonSearchFilter" |
field | string (EPersonSearchFilterField) Enum: "PERSON_SOURCE" "SOURCE_ID" "SOURCE_DATA" "FIRST_NAME" "LAST_NAME" "USERNAME" "NICKNAME" "PERSON_TYPE" "AUTHORIZATION_ROLE" "EMAIL" "PHONE" "TEAM_ID" enum-descriptions: ["PERSON_SOURCE: Filter by the 'personSource' attribute","SOURCE_ID: Filter by the 'sourceId' attribute","SOURCE_DATA: Filter by the 'sourceData' attribute","FIRST_NAME: Filter by the 'firstName' attribute","LAST_NAME: Filter by the 'lastName' attribute","USERNAME: Filter by the 'username' attribute","NICKNAME: Filter by the 'nickname' attribute","PERSON_TYPE: Filter by the 'personType' attribute","AUTHORIZATION_ROLE: Filter by the 'authorizationRole' attribute","EMAIL: Filter by the 'email' attribute","PHONE: Filter by the 'phone' attribute","TEAM_ID: Filter by the 'teamId' attribute"] |
any (StringOperator) |
{- "$_type": "SourceIdPersonSearchFilter",
- "field": "PERSON_SOURCE",
- "operator": {
- "$_type": "EqualsStringOperator",
- "type": "EQUALS",
- "value": "string"
}
}
$_type | string Default: "StateConversationSearchFilter" Value: "StateConversationSearchFilter" |
field | string (EConversationSearchFilterField) Enum: "CREATION_TIMESTAMP" "END_TIMESTAMP" "INITIAL_ENGAGEMENT_TYPE" "TOPIC" "CONTEXT_PERSON_ID" "ASSIGNEE_PERSON_ID" "PARTICIPANT_PERSON_ID" "STATE" "END_REASON" "CONVERSATION_TEMPLATE_ID" "RECIPIENT_ID" "RECIPIENT_TYPE" "TOKBOX_SESSION_ID" enum-descriptions: ["CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","END_TIMESTAMP: Filter by the 'endTimestamp' attribute","INITIAL_ENGAGEMENT_TYPE: Filter by the 'initialEngagementType' attribute","TOPIC: Filter by the 'topic' attribute","CONTEXT_PERSON_ID: Filter by the 'contextPersonId' attribute","ASSIGNEE_PERSON_ID: Filter by the 'assigneePersonId' attribute","PARTICIPANT_PERSON_ID: Filter by the 'personId' of the participants","STATE: Filter by the 'state' attribute","END_REASON: Filter by the 'endReason' attribute","CONVERSATION_TEMPLATE_ID: Filter by the 'conversationTemplateId' attribute","RECIPIENT_ID: Filter by the 'id' of the 'recipient' attribute","RECIPIENT_TYPE: Filter by the 'type' of the 'recipient' attribute","TOKBOX_SESSION_ID: Filter by the 'tokboxSessionId' attribute"] |
any (ConversationStateOperator) |
{- "$_type": "StateConversationSearchFilter",
- "field": "CREATION_TIMESTAMP",
- "operator": {
- "$_type": "EqualsConversationStateOperator",
- "type": "EQUALS",
- "value": "CREATED"
}
}
$_type | string Default: "ContainsStringOperator" Value: "ContainsStringOperator" |
type | string (EStringOperatorType) enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator","IS_NULL: Check if the value is null","IS_NOT_NULL: Check if the value is not null","CONTAINS: Check if the value contains the string provided in the operator"] CONTAINS EQUALS NOT_EQUALS IN NOT_IN IS_NULL IS_NOT_NULL CONTAINS |
value | string |
{- "$_type": "ContainsStringOperator",
- "type": "CONTAINS",
- "value": "string"
}
$_type | string Default: "TargetIdConversationInvitationSearchFilter" Value: "TargetIdConversationInvitationSearchFilter" |
field | string (EConversationInvitationSearchFilterField) Enum: "INVITATION_TYPE" "TARGET_TYPE" "CONVERSATION_ID" "TARGET_ID" "EXPIRATION_TIMESTAMP" "CREATION_TIMESTAMP" "CREATOR_TYPE" "CREATOR_PERSON_ID" "REDEEMING_PERSON_ID" enum-descriptions: ["INVITATION_TYPE: Filter by the 'type' attribute","TARGET_TYPE: Filter by the 'targetType' attribute","CONVERSATION_ID: Filter by the 'conversationId' attribute","TARGET_ID: Filter by the 'targetId' attribute","EXPIRATION_TIMESTAMP: Filter by the 'expirationTimestamp' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","CREATOR_TYPE: Filter by the 'creatorType' attribute","CREATOR_PERSON_ID: Filter by the 'creatorId' attribute","REDEEMING_PERSON_ID: Filter by the 'redeemerPersonId' attribute"] |
any (IdOperator) Defines operators used for comparing id fields in tables. |
{- "$_type": "TargetIdConversationInvitationSearchFilter",
- "field": "INVITATION_TYPE",
- "operator": {
- "$_type": "EqualsIdOperator",
- "type": "EQUALS",
- "value": "string"
}
}
$_type | string Default: "TargetTypeConversationInvitationSearchFilter" Value: "TargetTypeConversationInvitationSearchFilter" |
field | string (EConversationInvitationSearchFilterField) Enum: "INVITATION_TYPE" "TARGET_TYPE" "CONVERSATION_ID" "TARGET_ID" "EXPIRATION_TIMESTAMP" "CREATION_TIMESTAMP" "CREATOR_TYPE" "CREATOR_PERSON_ID" "REDEEMING_PERSON_ID" enum-descriptions: ["INVITATION_TYPE: Filter by the 'type' attribute","TARGET_TYPE: Filter by the 'targetType' attribute","CONVERSATION_ID: Filter by the 'conversationId' attribute","TARGET_ID: Filter by the 'targetId' attribute","EXPIRATION_TIMESTAMP: Filter by the 'expirationTimestamp' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","CREATOR_TYPE: Filter by the 'creatorType' attribute","CREATOR_PERSON_ID: Filter by the 'creatorId' attribute","REDEEMING_PERSON_ID: Filter by the 'redeemerPersonId' attribute"] |
any (InvitationTargetTypeOperator) |
{- "$_type": "TargetTypeConversationInvitationSearchFilter",
- "field": "INVITATION_TYPE",
- "operator": {
- "$_type": "EqualsInvitationTargetTypeOperator",
- "type": "EQUALS",
- "value": "ANONYMOUS"
}
}
$_type | string Default: "Team" Value: "Team" |
id | string Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway. |
creationTimestamp | integer <int64> Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
modificationTimestamp | integer <int64> Timestamp of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
version | integer <int64> Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted. |
accountId | string Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
string or Avatar (object) expand-query-key: avatar type: ExpandableField Avatar of the entity: id that can be expanded. | |
name | string Name of the team. Maximum of 250 characters. Can not be omitted. |
parentId | string Id of the parent team. Only the default team has no parent team. When creating a team and the parentId is omitted, the default team is automatically inserted by the server. |
description | string Description of the team. Maximum of 500 characters. Can be omitted. |
externallyManaged | boolean True if the team is externally managed and cannot be edited in the Unblu user interface. If omitted, the property is set to false. |
object expand-query-key: configuration type: Map The entity's configuration properties. Only contains values when the 'expand' query parameter is used with the value 'configuration'. | |
object expand-query-key: metadata type: Map The entity's metadata properties. Only contains values when the 'expand' query parameter is used with the value 'metadata'. |
{- "$_type": "Team",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "avatar": "string",
- "name": "string",
- "parentId": "string",
- "description": "string",
- "externallyManaged": true,
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
$_type | string Default: "TeamData" Value: "TeamData" |
id | string Unique id of the team. |
accountId | string Account id to which a team belongs to. |
displayName | string Display-Name of the team |
string or Avatar (object) expand-query-key: avatar type: ExpandableField Avatar of the team: id that can be expanded. | |
parentId | string Id of the parent team. Only the default team has no parent team. When creating a team and the parentId is omitted, the default team is automatically inserted by the server. |
{- "$_type": "TeamData",
- "id": "string",
- "accountId": "string",
- "displayName": "string",
- "avatar": "string",
- "parentId": "string"
}
$_type | string Default: "TeamIdPersonSearchFilter" Value: "TeamIdPersonSearchFilter" |
field | string (EPersonSearchFilterField) Enum: "PERSON_SOURCE" "SOURCE_ID" "SOURCE_DATA" "FIRST_NAME" "LAST_NAME" "USERNAME" "NICKNAME" "PERSON_TYPE" "AUTHORIZATION_ROLE" "EMAIL" "PHONE" "TEAM_ID" enum-descriptions: ["PERSON_SOURCE: Filter by the 'personSource' attribute","SOURCE_ID: Filter by the 'sourceId' attribute","SOURCE_DATA: Filter by the 'sourceData' attribute","FIRST_NAME: Filter by the 'firstName' attribute","LAST_NAME: Filter by the 'lastName' attribute","USERNAME: Filter by the 'username' attribute","NICKNAME: Filter by the 'nickname' attribute","PERSON_TYPE: Filter by the 'personType' attribute","AUTHORIZATION_ROLE: Filter by the 'authorizationRole' attribute","EMAIL: Filter by the 'email' attribute","PHONE: Filter by the 'phone' attribute","TEAM_ID: Filter by the 'teamId' attribute"] |
any (StringOperator) |
{- "$_type": "TeamIdPersonSearchFilter",
- "field": "PERSON_SOURCE",
- "operator": {
- "$_type": "EqualsStringOperator",
- "type": "EQUALS",
- "value": "string"
}
}
$_type | string Default: "TeamIdUserSearchFilter" Value: "TeamIdUserSearchFilter" |
field | string (EUserSearchFilterField) Enum: "FIRST_NAME" "LAST_NAME" "USERNAME" "TEAM_ID" "EMAIL" "AUTHORIZATION_ROLE" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" "VIRTUAL_USER" enum-descriptions: ["FIRST_NAME: Filter by the 'firstName' attribute","LAST_NAME: Filter by the 'lastName' attribute","USERNAME: Filter by the 'username' attribute","TEAM_ID: Filter by the 'teamId' attribute","EMAIL: Filter by the 'email' attribute","AUTHORIZATION_ROLE: Filter by the 'authorizationRole' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute","VIRTUAL_USER: Filter by the 'virtualUser' attribute"] |
any (IdOperator) Defines operators used for comparing id fields in tables. |
{- "$_type": "TeamIdUserSearchFilter",
- "field": "FIRST_NAME",
- "operator": {
- "$_type": "EqualsIdOperator",
- "type": "EQUALS",
- "value": "string"
}
}
$_type | string Default: "TeamModificationEvent" Value: "TeamModificationEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
action | string (EntityModificationAction) Enum: "CREATE" "UPDATE" "DELETE" enum-descriptions: ["CREATE: Entity was created","UPDATE: Entity was updated","DELETE: Entity was deleted"] Type of modification of an entity |
object (Team) Model of a team. A team consist out of multiple users. For each account there is at least the default team. | |
object (UserInfo) User information which are normally used together with webhook events. |
{- "$_type": "TeamModificationEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "action": "CREATE",
- "entity": {
- "$_type": "Team",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "avatar": "string",
- "name": "string",
- "parentId": "string",
- "description": "string",
- "externallyManaged": true,
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "editingUser": {
- "$_type": "UserInfo",
- "userId": "string",
- "userName": "string",
- "firstName": "string",
- "lastName": "string",
- "displayName": "string"
}
}
$_type | string Default: "TeamOrderBy" Value: "TeamOrderBy" |
field | string (ETeamOrderByField) Enum: "ID" "NAME" "DESCRIPTION" "PARENT_ID" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["ID: Sort by the 'id' attribute","NAME: Sort by the 'name' attribute","DESCRIPTION: Sort by the 'description' attribute","PARENT_ID: Sort by the 'parentId' attribute","CREATION_TIMESTAMP: Sort by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Sort by the 'modificationTimestamp' attribute"] |
order | string (Order) Enum: "ASCENDING" "DESCENDING" enum-descriptions: ["ASCENDING: Sort in the ascending order (smallest to largest, 0 to 9, and/or A to Z)","DESCENDING: Sort in the descending order (largest to smallest, 9 to 0, and/or Z to A)"] |
{- "$_type": "TeamOrderBy",
- "field": "ID",
- "order": "ASCENDING"
}
$_type | string Default: "TeamQuery" Value: "TeamQuery" |
Array of any (TeamSearchFilter) [ items ] List of filters to narrow the search of entities | |
Array of objects (TeamOrderBy) [ items ] List of criteria to order the search result list | |
offset | integer <int32> Offset position in the result set to start pagination |
limit | integer <int32> Maximal amount of items returned |
{- "$_type": "TeamQuery",
- "searchFilters": [
- {
- "$_type": "CreationTimestampTeamSearchFilter",
- "field": "NAME",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
], - "orderBy": [
- {
- "$_type": "TeamOrderBy",
- "field": "ID",
- "order": "ASCENDING"
}
], - "offset": 0,
- "limit": 0
}
$_type | string Default: "TeamResult" Value: "TeamResult" |
hasMoreItems | boolean Flag to indicate if there are more items on the server |
nextOffset | integer <int32> If more items are present on the server, this value can be used as offset in the next query |
Array of objects (Team) [ items ] The returned list of entities |
{- "$_type": "TeamResult",
- "hasMoreItems": true,
- "nextOffset": 0,
- "items": [
- {
- "$_type": "Team",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "avatar": "string",
- "name": "string",
- "parentId": "string",
- "description": "string",
- "externallyManaged": true,
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
]
}
$_type | string Default: "CreationTimestampTeamSearchFilter" Value: "CreationTimestampTeamSearchFilter" |
field | string (ETeamSearchFilterField) enum-descriptions: ["NAME: Filter by the 'name' attribute","DESCRIPTION: Filter by the 'description' attribute","PARENT_ID: Filter by the 'parentId' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] CREATION_TIMESTAMP NAME DESCRIPTION PARENT_ID CREATION_TIMESTAMP MODIFICATION_TIMESTAMP |
any (TimestampOperator) |
{- "$_type": "CreationTimestampTeamSearchFilter",
- "field": "CREATION_TIMESTAMP",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
$_type | string Default: "TextCannedResponseSearchFilter" Value: "TextCannedResponseSearchFilter" |
field | string (ECannedResponseSearchFilterField) Enum: "KEY" "TITLE" "TEXT" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["KEY: Filter by the 'key' attribute","TITLE: Filter by the 'title' attribute","TEXT: Filter by the 'text' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] |
any (StringOperator) |
{- "$_type": "TextCannedResponseSearchFilter",
- "field": "KEY",
- "operator": {
- "$_type": "EqualsStringOperator",
- "type": "EQUALS",
- "value": "string"
}
}
$_type | string Default: "TextMessageData" Value: "TextMessageData" |
id | string The ID of the message. |
conversationId | string Conversation ID to which this message belongs to |
externalMessengerChannelId | string ID of the external messenger channel connected to the conversation. Null if the conversation is not connected to an external messenger. |
accountId | string Account ID to which this message and conversation belongs to. |
object (PersonData) Representation of a Person (Agent or Visitor). | |
senderPersonPresenceId | string Id of the person presence that sends the message. May be null if the message was sent by the system. |
serverTimestamp | integer <int64> utc timestamp when the message was received on the server. |
sendTimestamp | integer <int64> utc timestamp when the message was sent from the client |
type | string (EMessageType) Enum: "TEXT" "FILE" "CARD" "LIST" "APPROVAL_REQUEST" "MULTICHOICE_QUESTION" "RATING_QUESTION" "TEXT_QUESTION" "REPLY" "QUESTION_ABORTED" enum-descriptions: ["TEXT","FILE","CARD","LIST","APPROVAL_REQUEST","MULTICHOICE_QUESTION","RATING_QUESTION","TEXT_QUESTION","REPLY","QUESTION_ABORTED"] The message type of a conversation message |
recipientPersonIds | Array of strings Person IDs of the recipients of the message. If it is null, all active participations are recipients |
fallbackText | string Text representation of the message which is used in following cases:
The fallback text can be provided by the sender (bot, external messenger) or is generated when missing. This may however not always be a perfect textual representation of the message. |
actionId | string An ID of the action triggering the message to be able to identify a message created by an action. |
sourceId | string A custom ID which identifies where this message initially came from. |
text | string Text of the message |
textType | string (EConversationMessageTextType) Enum: "SIMPLE_TEXT" "MARKDOWN" enum-descriptions: ["SIMPLE_TEXT: Text will be interpreted as simple text. <p> Auto link detection will still be possible.","MARKDOWN: Text will be interpreted as Markdown. <p> The supported Markdown subset depends on the message type."] How text in a conversation message should be interpreted. |
Array of objects (QuickReply) [ items ] Optional quick replies which will be displayed above the chat input as a possible response options |
{- "$_type": "TextMessageData",
- "id": "string",
- "conversationId": "string",
- "externalMessengerChannelId": "string",
- "accountId": "string",
- "senderPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "senderPersonPresenceId": "string",
- "serverTimestamp": 0,
- "sendTimestamp": 0,
- "type": "TEXT",
- "recipientPersonIds": [
- "string"
], - "fallbackText": "string",
- "actionId": "string",
- "sourceId": "string",
- "text": "string",
- "textType": "SIMPLE_TEXT",
- "quickReplies": [
- {
- "$_type": "QuickReply",
- "text": "string"
}
]
}
$_type | string Default: "TextPostMessageData" Value: "TextPostMessageData" |
type | string (EPostMessageType) Enum: "TEXT" "FILE" "CARD" "LIST" "MULTICHOICE_QUESTION" "RATING_QUESTION" "TEXT_QUESTION" "REPLY" enum-descriptions: ["TEXT: See `TextPostMessageData`","FILE: See `FilePostMessageData`","CARD: See `CardPostMessageData`","LIST: See `ListPostMessageData`","MULTICHOICE_QUESTION: See `MultichoiceQuestionPostMessageData`","RATING_QUESTION: See `RatingQuestionPostMessageData`","TEXT_QUESTION: See `TextQuestionPostMessageData`","REPLY: See `ReplyPostMessageData`"] Type of a message which is send to the collaboration server |
fallbackText | string Optional fallback text which is used when:
The value must not contain markdown. If no fallback is given, a fallback text based on the content of the message is generated. This may however not always be a perfect textual representation of the message. |
text | string Message text |
textType | string (EConversationMessageTextType) Enum: "SIMPLE_TEXT" "MARKDOWN" enum-descriptions: ["SIMPLE_TEXT: Text will be interpreted as simple text. <p> Auto link detection will still be possible.","MARKDOWN: Text will be interpreted as Markdown. <p> The supported Markdown subset depends on the message type."] How text in a conversation message should be interpreted. |
Array of objects (QuickReply) [ items ] Optional list of quick replies available to the message's recipients Max number of quick replies is 13. |
{- "$_type": "TextPostMessageData",
- "type": "TEXT",
- "fallbackText": "string",
- "text": "string",
- "textType": "SIMPLE_TEXT",
- "quickReplies": [
- {
- "$_type": "QuickReply",
- "text": "string"
}
]
}
$_type | string Default: "TextQuestionMessageData" Value: "TextQuestionMessageData" |
id | string The ID of the message. |
conversationId | string Conversation ID to which this message belongs to |
externalMessengerChannelId | string ID of the external messenger channel connected to the conversation. Null if the conversation is not connected to an external messenger. |
accountId | string Account ID to which this message and conversation belongs to. |
object (PersonData) Representation of a Person (Agent or Visitor). | |
senderPersonPresenceId | string Id of the person presence that sends the message. May be null if the message was sent by the system. |
serverTimestamp | integer <int64> utc timestamp when the message was received on the server. |
sendTimestamp | integer <int64> utc timestamp when the message was sent from the client |
type | string (EMessageType) Enum: "TEXT" "FILE" "CARD" "LIST" "APPROVAL_REQUEST" "MULTICHOICE_QUESTION" "RATING_QUESTION" "TEXT_QUESTION" "REPLY" "QUESTION_ABORTED" enum-descriptions: ["TEXT","FILE","CARD","LIST","APPROVAL_REQUEST","MULTICHOICE_QUESTION","RATING_QUESTION","TEXT_QUESTION","REPLY","QUESTION_ABORTED"] The message type of a conversation message |
recipientPersonIds | Array of strings Person IDs of the recipients of the message. If it is null, all active participations are recipients |
fallbackText | string Text representation of the message which is used in following cases:
The fallback text can be provided by the sender (bot, external messenger) or is generated when missing. This may however not always be a perfect textual representation of the message. |
actionId | string An ID of the action triggering the message to be able to identify a message created by an action. |
sourceId | string A custom ID which identifies where this message initially came from. |
text | string Text of the message |
textType | string (EConversationMessageTextType) Enum: "SIMPLE_TEXT" "MARKDOWN" enum-descriptions: ["SIMPLE_TEXT: Text will be interpreted as simple text. <p> Auto link detection will still be possible.","MARKDOWN: Text will be interpreted as Markdown. <p> The supported Markdown subset depends on the message type."] How text in a conversation message should be interpreted. |
questionType | string (ETextQuestionType) Enum: "SHORT_TEXT" "LONG_TEXT" "URL" "EMAIL" "PHONE" "DATE" "TIME" "DATETIME" "NUMBER" enum-descriptions: ["SHORT_TEXT: Reply should only be a short text.","LONG_TEXT: Reply can be be a long text. Visually displayed with a larger input field.","URL: Reply has to be a URL","EMAIL: Reply has to be a mail address","PHONE: Reply has to be a phone number","DATE: Reply has to be a date","TIME: Reply has to be a time","DATETIME: Reply has to be a date and a time","NUMBER: Reply has to be a number"] Type of a question message. Defines the reply value of a text message. |
hint | string Hint which is displayed inside the reply field to give the user a hint, what the answer should contain. |
minCharacters | integer <int32> Minimum amount of characters the user has to answer with. |
maxCharacters | integer <int32> Maximum amount if characters the user can answer with. |
additionalRegex | string The reply has to match this regex. |
declinable | boolean Whether the question can be declined |
declineLabel | string Label for the decline button which will also be used as text for the reply |
declineValue | string Value which will be propagated as reply value if the question is declined |
answerStatus | string (EAnswerStatus) Enum: "PENDING" "ANSWERED" "TIMEDOUT" "CANCELED" enum-descriptions: ["PENDING: Question is not answered yet","ANSWERED: Question was successfully answered","TIMEDOUT: Question was running into a timeout","CANCELED: Question was canceled by the system, a bot or an external messenger channel"] The state of a question message |
{- "$_type": "TextQuestionMessageData",
- "id": "string",
- "conversationId": "string",
- "externalMessengerChannelId": "string",
- "accountId": "string",
- "senderPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "senderPersonPresenceId": "string",
- "serverTimestamp": 0,
- "sendTimestamp": 0,
- "type": "TEXT",
- "recipientPersonIds": [
- "string"
], - "fallbackText": "string",
- "actionId": "string",
- "sourceId": "string",
- "text": "string",
- "textType": "SIMPLE_TEXT",
- "questionType": "SHORT_TEXT",
- "hint": "string",
- "minCharacters": 0,
- "maxCharacters": 0,
- "additionalRegex": "string",
- "declinable": true,
- "declineLabel": "string",
- "declineValue": "string",
- "answerStatus": "PENDING"
}
$_type | string Default: "TextQuestionPostMessageData" Value: "TextQuestionPostMessageData" |
type | string (EPostMessageType) Enum: "TEXT" "FILE" "CARD" "LIST" "MULTICHOICE_QUESTION" "RATING_QUESTION" "TEXT_QUESTION" "REPLY" enum-descriptions: ["TEXT: See `TextPostMessageData`","FILE: See `FilePostMessageData`","CARD: See `CardPostMessageData`","LIST: See `ListPostMessageData`","MULTICHOICE_QUESTION: See `MultichoiceQuestionPostMessageData`","RATING_QUESTION: See `RatingQuestionPostMessageData`","TEXT_QUESTION: See `TextQuestionPostMessageData`","REPLY: See `ReplyPostMessageData`"] Type of a message which is send to the collaboration server |
fallbackText | string Optional fallback text which is used when:
The value must not contain markdown. If no fallback is given, a fallback text based on the content of the message is generated. This may however not always be a perfect textual representation of the message. |
text | string Message text |
textType | string (EConversationMessageTextType) Enum: "SIMPLE_TEXT" "MARKDOWN" enum-descriptions: ["SIMPLE_TEXT: Text will be interpreted as simple text. <p> Auto link detection will still be possible.","MARKDOWN: Text will be interpreted as Markdown. <p> The supported Markdown subset depends on the message type."] How text in a conversation message should be interpreted. |
questionType | string (ETextQuestionType) Enum: "SHORT_TEXT" "LONG_TEXT" "URL" "EMAIL" "PHONE" "DATE" "TIME" "DATETIME" "NUMBER" enum-descriptions: ["SHORT_TEXT: Reply should only be a short text.","LONG_TEXT: Reply can be be a long text. Visually displayed with a larger input field.","URL: Reply has to be a URL","EMAIL: Reply has to be a mail address","PHONE: Reply has to be a phone number","DATE: Reply has to be a date","TIME: Reply has to be a time","DATETIME: Reply has to be a date and a time","NUMBER: Reply has to be a number"] Type of a question message. Defines the reply value of a text message. |
hint | string Hint which is displayed inside the reply field to give the user a hint, what the answer should contain. |
minCharacters | integer <int32> Minimum amount of characters the user has to answer with. |
maxCharacters | integer <int32> Maximum amount if characters the user can answer with. |
additionalRegex | string The reply has to match this regex. |
declinable | boolean Whether the question can be declined |
declineLabel | string Label for the decline button which will also be used as text for the reply |
declineValue | string Value which will be propagated as reply value if the question is declined |
{- "$_type": "TextQuestionPostMessageData",
- "type": "TEXT",
- "fallbackText": "string",
- "text": "string",
- "textType": "SIMPLE_TEXT",
- "questionType": "SHORT_TEXT",
- "hint": "string",
- "minCharacters": 0,
- "maxCharacters": 0,
- "additionalRegex": "string",
- "declinable": true,
- "declineLabel": "string",
- "declineValue": "string"
}
$_type | string Default: "EqualsTimestampOperator" Value: "EqualsTimestampOperator" |
type | string (ETimestampOperatorType) enum-descriptions: ["EQUALS: Check if the value is equals to the one provided in the operator","NOT_EQUALS: Check if the value not is equals to the one provided in the operator","GREATER_THAN: Check if the value is greater than the one provided in the operator","LOWER_THAN: Check if the value is lower than the one provided in the operator","IN: Check if the value is one of the one provided in the operator","NOT_IN: Check if the value is not one of the one provided in the operator","IS_NULL: Check if the value is null","IS_NOT_NULL: Check if the value is not null","IN_RANGE: Check if the value is in the range of the provided values. Results equal to the provided values are included.","NOT_IN_RANGE: Check if the value is NOT in the range of the provided values. Results equal to the provided values are not included."] EQUALS EQUALS NOT_EQUALS GREATER_THAN LOWER_THAN IN NOT_IN IS_NULL IS_NOT_NULL IN_RANGE NOT_IN_RANGE |
value | integer <int64> |
{- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
$_type | string Default: "TitleCannedResponseSearchFilter" Value: "TitleCannedResponseSearchFilter" |
field | string (ECannedResponseSearchFilterField) Enum: "KEY" "TITLE" "TEXT" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["KEY: Filter by the 'key' attribute","TITLE: Filter by the 'title' attribute","TEXT: Filter by the 'text' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] |
any (StringOperator) |
{- "$_type": "TitleCannedResponseSearchFilter",
- "field": "KEY",
- "operator": {
- "$_type": "EqualsStringOperator",
- "type": "EQUALS",
- "value": "string"
}
}
$_type | string Default: "TokboxSessionIdConversationSearchFilter" Value: "TokboxSessionIdConversationSearchFilter" |
field | string (EConversationSearchFilterField) Enum: "CREATION_TIMESTAMP" "END_TIMESTAMP" "INITIAL_ENGAGEMENT_TYPE" "TOPIC" "CONTEXT_PERSON_ID" "ASSIGNEE_PERSON_ID" "PARTICIPANT_PERSON_ID" "STATE" "END_REASON" "CONVERSATION_TEMPLATE_ID" "RECIPIENT_ID" "RECIPIENT_TYPE" "TOKBOX_SESSION_ID" enum-descriptions: ["CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","END_TIMESTAMP: Filter by the 'endTimestamp' attribute","INITIAL_ENGAGEMENT_TYPE: Filter by the 'initialEngagementType' attribute","TOPIC: Filter by the 'topic' attribute","CONTEXT_PERSON_ID: Filter by the 'contextPersonId' attribute","ASSIGNEE_PERSON_ID: Filter by the 'assigneePersonId' attribute","PARTICIPANT_PERSON_ID: Filter by the 'personId' of the participants","STATE: Filter by the 'state' attribute","END_REASON: Filter by the 'endReason' attribute","CONVERSATION_TEMPLATE_ID: Filter by the 'conversationTemplateId' attribute","RECIPIENT_ID: Filter by the 'id' of the 'recipient' attribute","RECIPIENT_TYPE: Filter by the 'type' of the 'recipient' attribute","TOKBOX_SESSION_ID: Filter by the 'tokboxSessionId' attribute"] |
any (StringOperator) |
{- "$_type": "TokboxSessionIdConversationSearchFilter",
- "field": "CREATION_TIMESTAMP",
- "operator": {
- "$_type": "EqualsStringOperator",
- "type": "EQUALS",
- "value": "string"
}
}
$_type | string Default: "TopicConversationSearchFilter" Value: "TopicConversationSearchFilter" |
field | string (EConversationSearchFilterField) Enum: "CREATION_TIMESTAMP" "END_TIMESTAMP" "INITIAL_ENGAGEMENT_TYPE" "TOPIC" "CONTEXT_PERSON_ID" "ASSIGNEE_PERSON_ID" "PARTICIPANT_PERSON_ID" "STATE" "END_REASON" "CONVERSATION_TEMPLATE_ID" "RECIPIENT_ID" "RECIPIENT_TYPE" "TOKBOX_SESSION_ID" enum-descriptions: ["CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","END_TIMESTAMP: Filter by the 'endTimestamp' attribute","INITIAL_ENGAGEMENT_TYPE: Filter by the 'initialEngagementType' attribute","TOPIC: Filter by the 'topic' attribute","CONTEXT_PERSON_ID: Filter by the 'contextPersonId' attribute","ASSIGNEE_PERSON_ID: Filter by the 'assigneePersonId' attribute","PARTICIPANT_PERSON_ID: Filter by the 'personId' of the participants","STATE: Filter by the 'state' attribute","END_REASON: Filter by the 'endReason' attribute","CONVERSATION_TEMPLATE_ID: Filter by the 'conversationTemplateId' attribute","RECIPIENT_ID: Filter by the 'id' of the 'recipient' attribute","RECIPIENT_TYPE: Filter by the 'type' of the 'recipient' attribute","TOKBOX_SESSION_ID: Filter by the 'tokboxSessionId' attribute"] |
any (StringOperator) |
{- "$_type": "TopicConversationSearchFilter",
- "field": "CREATION_TIMESTAMP",
- "operator": {
- "$_type": "EqualsStringOperator",
- "type": "EQUALS",
- "value": "string"
}
}
$_type | string Default: "User" Value: "User" |
id | string Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway. |
creationTimestamp | integer <int64> Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
modificationTimestamp | integer <int64> Timestamp of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
version | integer <int64> Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted. |
accountId | string Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
string or Avatar (object) expand-query-key: avatar type: ExpandableField Avatar of the entity: id that can be expanded. | |
username | string The username for the login. Depending on the configuration, this is may also the email. Maximum length of 250 characters. Can not be omitted. When creating/updating a user and configuration 'storage.user.useEmailAsUsername' is enabled, this value must be the same as the email address. |
string The email address of the user. Maximum length of 250 characters. Can not be omitted, but can be an empty string, if storage.user.useEmailAsUsername is not used. | |
phone | string The phone number of the user. Maximum length of 100 characters. |
teamId | string The id of the team the user belongs to. This can be omitted, when creating a user and will be filled by the server with the default team id of the account. |
authorizationRole | string (EAuthorizationRole) Enum: "SUPER_ADMIN" "PARTNER" "TECHNICAL_ADMIN" "ADMIN" "SUPERVISOR" "REGISTERED_USER" "WEBUSER" "ANONYMOUS_USER" enum-descriptions: ["SUPER_ADMIN: Super admin role. Only for unblu or system admins","PARTNER: Partner role. (no longer used)","TECHNICAL_ADMIN: Technical admin role.","ADMIN: Admin role. For Admins of the system","SUPERVISOR: Supervisor role. For users which manage teams","REGISTERED_USER: User role. For normal users (agents)","WEBUSER: Webuser role. For internal representation of users from the outside","ANONYMOUS_USER: Anonymous role. For internal representation of unknown users"] The authorization role is mainly used for access definition of a service |
displayName | string The display name of the user. Will be calculated by the server. Can be omitted while creating a user. |
firstName | string The first name of the user. Maximum length of 250 characters. Can not be omitted. |
lastName | string The user's last name. Maximum length of 250 characters. Cannot be omitted. |
externallyManaged | boolean True if the user is externally managed and cannot be edited in the Unblu user interface. If omitted, the property is set to false. |
virtualUser | boolean True if the user is pure virtual (i.e. not created beforehand by LDAP sync for instance) and therefore can not be edited by the Unblu user interface. If omitted, the property is set to false. |
object expand-query-key: configuration type: Map The entity's configuration properties. Only contains values when the 'expand' query parameter is used with the value 'configuration'. | |
object expand-query-key: metadata type: Map The entity's metadata properties. Only contains values when the 'expand' query parameter is used with the value 'metadata'. |
{- "$_type": "User",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "avatar": "string",
- "username": "string",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "authorizationRole": "SUPER_ADMIN",
- "displayName": "string",
- "firstName": "string",
- "lastName": "string",
- "externallyManaged": true,
- "virtualUser": true,
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
$_type | string Default: "UserInfo" Value: "UserInfo" |
userId | string The id of the user |
userName | string The username of the user |
firstName | string The first name of the user |
lastName | string The last name of the user |
displayName | string The display name of the user |
{- "$_type": "UserInfo",
- "userId": "string",
- "userName": "string",
- "firstName": "string",
- "lastName": "string",
- "displayName": "string"
}
$_type | string Default: "UserModificationEvent" Value: "UserModificationEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
action | string (EntityModificationAction) Enum: "CREATE" "UPDATE" "DELETE" enum-descriptions: ["CREATE: Entity was created","UPDATE: Entity was updated","DELETE: Entity was deleted"] Type of modification of an entity |
object (User) Model of a user. A user is normally an agent and/or a person who manages the system | |
object (UserInfo) User information which are normally used together with webhook events. |
{- "$_type": "UserModificationEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "action": "CREATE",
- "entity": {
- "$_type": "User",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "avatar": "string",
- "username": "string",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "authorizationRole": "SUPER_ADMIN",
- "displayName": "string",
- "firstName": "string",
- "lastName": "string",
- "externallyManaged": true,
- "virtualUser": true,
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "editingUser": {
- "$_type": "UserInfo",
- "userId": "string",
- "userName": "string",
- "firstName": "string",
- "lastName": "string",
- "displayName": "string"
}
}
$_type | string Default: "UserOrderBy" Value: "UserOrderBy" |
field | string (EUserOrderByField) Enum: "ID" "FIRST_NAME" "LAST_NAME" "AUTHORIZATION_ROLE" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["ID: Sort by the 'id' attribute","FIRST_NAME: Sort by the 'firstName' attribute","LAST_NAME: Sort by the 'lastName' attribute","AUTHORIZATION_ROLE: Sort by the 'authorizationRole' attribute","CREATION_TIMESTAMP: Sort by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Sort by the 'modificationTimestamp' attribute"] |
order | string (Order) Enum: "ASCENDING" "DESCENDING" enum-descriptions: ["ASCENDING: Sort in the ascending order (smallest to largest, 0 to 9, and/or A to Z)","DESCENDING: Sort in the descending order (largest to smallest, 9 to 0, and/or Z to A)"] |
{- "$_type": "UserOrderBy",
- "field": "ID",
- "order": "ASCENDING"
}
$_type | string Default: "UserPasswordContainer" Value: "UserPasswordContainer" |
object (User) Model of a user. A user is normally an agent and/or a person who manages the system | |
password | string The password which belongs to the user |
{- "$_type": "UserPasswordContainer",
- "user": {
- "$_type": "User",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "avatar": "string",
- "username": "string",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "authorizationRole": "SUPER_ADMIN",
- "displayName": "string",
- "firstName": "string",
- "lastName": "string",
- "externallyManaged": true,
- "virtualUser": true,
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "password": "string"
}
$_type | string Default: "UserQuery" Value: "UserQuery" |
Array of any (UserSearchFilter) [ items ] List of filters to narrow the search of entities | |
Array of objects (UserOrderBy) [ items ] List of criteria to order the search result list | |
offset | integer <int32> Offset position in the result set to start pagination |
limit | integer <int32> Maximal amount of items returned |
{- "$_type": "UserQuery",
- "searchFilters": [
- {
- "$_type": "AuthorizationRoleUserSearchFilter",
- "field": "FIRST_NAME",
- "operator": {
- "$_type": "EqualsAuthorizationRoleOperator",
- "type": "EQUALS",
- "value": "SUPER_ADMIN"
}
}
], - "orderBy": [
- {
- "$_type": "UserOrderBy",
- "field": "ID",
- "order": "ASCENDING"
}
], - "offset": 0,
- "limit": 0
}
$_type | string Default: "UserResult" Value: "UserResult" |
hasMoreItems | boolean Flag to indicate if there are more items on the server |
nextOffset | integer <int32> If more items are present on the server, this value can be used as offset in the next query |
Array of objects (User) [ items ] The returned list of entities |
{- "$_type": "UserResult",
- "hasMoreItems": true,
- "nextOffset": 0,
- "items": [
- {
- "$_type": "User",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "avatar": "string",
- "username": "string",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "authorizationRole": "SUPER_ADMIN",
- "displayName": "string",
- "firstName": "string",
- "lastName": "string",
- "externallyManaged": true,
- "virtualUser": true,
- "configuration": {
- "property1": "string",
- "property2": "string"
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}
]
}
$_type | string Default: "AuthorizationRoleUserSearchFilter" Value: "AuthorizationRoleUserSearchFilter" |
field | string (EUserSearchFilterField) enum-descriptions: ["FIRST_NAME: Filter by the 'firstName' attribute","LAST_NAME: Filter by the 'lastName' attribute","USERNAME: Filter by the 'username' attribute","TEAM_ID: Filter by the 'teamId' attribute","EMAIL: Filter by the 'email' attribute","AUTHORIZATION_ROLE: Filter by the 'authorizationRole' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute","VIRTUAL_USER: Filter by the 'virtualUser' attribute"] AUTHORIZATION_ROLE FIRST_NAME LAST_NAME USERNAME TEAM_ID EMAIL AUTHORIZATION_ROLE CREATION_TIMESTAMP MODIFICATION_TIMESTAMP VIRTUAL_USER |
any (AuthorizationRoleOperator) |
{- "$_type": "AuthorizationRoleUserSearchFilter",
- "field": "AUTHORIZATION_ROLE",
- "operator": {
- "$_type": "EqualsAuthorizationRoleOperator",
- "type": "EQUALS",
- "value": "SUPER_ADMIN"
}
}
$_type | string Default: "UsernamePersonSearchFilter" Value: "UsernamePersonSearchFilter" |
field | string (EPersonSearchFilterField) Enum: "PERSON_SOURCE" "SOURCE_ID" "SOURCE_DATA" "FIRST_NAME" "LAST_NAME" "USERNAME" "NICKNAME" "PERSON_TYPE" "AUTHORIZATION_ROLE" "EMAIL" "PHONE" "TEAM_ID" enum-descriptions: ["PERSON_SOURCE: Filter by the 'personSource' attribute","SOURCE_ID: Filter by the 'sourceId' attribute","SOURCE_DATA: Filter by the 'sourceData' attribute","FIRST_NAME: Filter by the 'firstName' attribute","LAST_NAME: Filter by the 'lastName' attribute","USERNAME: Filter by the 'username' attribute","NICKNAME: Filter by the 'nickname' attribute","PERSON_TYPE: Filter by the 'personType' attribute","AUTHORIZATION_ROLE: Filter by the 'authorizationRole' attribute","EMAIL: Filter by the 'email' attribute","PHONE: Filter by the 'phone' attribute","TEAM_ID: Filter by the 'teamId' attribute"] |
any (StringOperator) |
{- "$_type": "UsernamePersonSearchFilter",
- "field": "PERSON_SOURCE",
- "operator": {
- "$_type": "EqualsStringOperator",
- "type": "EQUALS",
- "value": "string"
}
}
$_type | string Default: "UsernameUserSearchFilter" Value: "UsernameUserSearchFilter" |
field | string (EUserSearchFilterField) Enum: "FIRST_NAME" "LAST_NAME" "USERNAME" "TEAM_ID" "EMAIL" "AUTHORIZATION_ROLE" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" "VIRTUAL_USER" enum-descriptions: ["FIRST_NAME: Filter by the 'firstName' attribute","LAST_NAME: Filter by the 'lastName' attribute","USERNAME: Filter by the 'username' attribute","TEAM_ID: Filter by the 'teamId' attribute","EMAIL: Filter by the 'email' attribute","AUTHORIZATION_ROLE: Filter by the 'authorizationRole' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute","VIRTUAL_USER: Filter by the 'virtualUser' attribute"] |
any (StringOperator) |
{- "$_type": "UsernameUserSearchFilter",
- "field": "FIRST_NAME",
- "operator": {
- "$_type": "EqualsStringOperator",
- "type": "EQUALS",
- "value": "string"
}
}
userId | string The id of the user which should be updated |
password | string The new password for the user |
{- "userId": "string",
- "password": "string"
}
$_type | string Default: "VirtualUserUserSearchFilter" Value: "VirtualUserUserSearchFilter" |
field | string (EUserSearchFilterField) Enum: "FIRST_NAME" "LAST_NAME" "USERNAME" "TEAM_ID" "EMAIL" "AUTHORIZATION_ROLE" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" "VIRTUAL_USER" enum-descriptions: ["FIRST_NAME: Filter by the 'firstName' attribute","LAST_NAME: Filter by the 'lastName' attribute","USERNAME: Filter by the 'username' attribute","TEAM_ID: Filter by the 'teamId' attribute","EMAIL: Filter by the 'email' attribute","AUTHORIZATION_ROLE: Filter by the 'authorizationRole' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute","VIRTUAL_USER: Filter by the 'virtualUser' attribute"] |
any (BooleanOperator) |
{- "$_type": "VirtualUserUserSearchFilter",
- "field": "FIRST_NAME",
- "operator": {
- "$_type": "EqualsBooleanOperator",
- "type": "EQUALS",
- "value": true
}
}
$_type | string Default: "VisitorInvitationCreatedEvent" Value: "VisitorInvitationCreatedEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
invitationId | string Id of the invitation |
conversationId | string Id of the conversation |
token | string Token (digits for pin or character sequence) requested to redeem or revoke the invitation |
dateCreated | integer <int64> Unix timestamp when the event was created |
creatorType | string (EInvitationCreatorType) Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR" enum-descriptions: ["WEB_API: Invitation created with the API","SYSTEM: Invitation created by the system","AGENT: Invitation created by an agent","VISITOR: Invitation created by a visitor"] The type of the person/system who created an invitation |
object (PersonData) Representation of a Person (Agent or Visitor). | |
string Visitor email | |
nickname | string Visitor nickname |
expirationTimestamp | integer <int64> Unix timestamp after witch the invitation is no longer valid |
Array of objects (ConversationLink) [ items ] List of links that can be used to accept the visitor invitation event with the token. |
{- "$_type": "VisitorInvitationCreatedEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "invitationId": "string",
- "conversationId": "string",
- "token": "string",
- "dateCreated": 0,
- "creatorType": "WEB_API",
- "creatorPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "email": "string",
- "nickname": "string",
- "expirationTimestamp": 0,
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
]
}
$_type | string Default: "VisitorInvitationRedeemedEvent" Value: "VisitorInvitationRedeemedEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
invitationId | string Id of the invitation |
conversationId | string Id of the conversation |
token | string Token (digits for pin or character sequence) requested to redeem or revoke the invitation |
dateCreated | integer <int64> Unix timestamp when the event was created |
creatorType | string (EInvitationCreatorType) Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR" enum-descriptions: ["WEB_API: Invitation created with the API","SYSTEM: Invitation created by the system","AGENT: Invitation created by an agent","VISITOR: Invitation created by a visitor"] The type of the person/system who created an invitation |
object (PersonData) Representation of a Person (Agent or Visitor). | |
string Visitor email | |
nickname | string Visitor nickname |
expirationTimestamp | integer <int64> Unix timestamp after witch the invitation is no longer valid |
object (PersonData) Representation of a Person (Agent or Visitor). |
{- "$_type": "VisitorInvitationRedeemedEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "invitationId": "string",
- "conversationId": "string",
- "token": "string",
- "dateCreated": 0,
- "creatorType": "WEB_API",
- "creatorPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "email": "string",
- "nickname": "string",
- "expirationTimestamp": 0,
- "redeemingPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}
}
$_type | string Default: "VisitorInvitationRenewedEvent" Value: "VisitorInvitationRenewedEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
invitationId | string Id of the invitation |
conversationId | string Id of the conversation |
token | string Token (digits for pin or character sequence) requested to redeem or revoke the invitation |
dateCreated | integer <int64> Unix timestamp when the event was created |
creatorType | string (EInvitationCreatorType) Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR" enum-descriptions: ["WEB_API: Invitation created with the API","SYSTEM: Invitation created by the system","AGENT: Invitation created by an agent","VISITOR: Invitation created by a visitor"] The type of the person/system who created an invitation |
object (PersonData) Representation of a Person (Agent or Visitor). | |
string Visitor email | |
nickname | string Visitor nickname |
expirationTimestamp | integer <int64> Unix timestamp after witch the invitation is no longer valid |
Array of objects (ConversationLink) [ items ] List of links that can be used to accept the visitor invitation event with the token. |
{- "$_type": "VisitorInvitationRenewedEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "invitationId": "string",
- "conversationId": "string",
- "token": "string",
- "dateCreated": 0,
- "creatorType": "WEB_API",
- "creatorPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "email": "string",
- "nickname": "string",
- "expirationTimestamp": 0,
- "links": [
- {
- "$_type": "ConversationLink",
- "type": "ACCEPT_IN_AGENT_DESK",
- "url": "string"
}
]
}
$_type | string Default: "VisitorInvitationRevokedEvent" Value: "VisitorInvitationRevokedEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
invitationId | string Id of the invitation |
conversationId | string Id of the conversation |
token | string Token (digits for pin or character sequence) requested to redeem or revoke the invitation |
dateCreated | integer <int64> Unix timestamp when the event was created |
creatorType | string (EInvitationCreatorType) Enum: "WEB_API" "SYSTEM" "AGENT" "VISITOR" enum-descriptions: ["WEB_API: Invitation created with the API","SYSTEM: Invitation created by the system","AGENT: Invitation created by an agent","VISITOR: Invitation created by a visitor"] The type of the person/system who created an invitation |
object (PersonData) Representation of a Person (Agent or Visitor). | |
string Visitor email | |
nickname | string Visitor nickname |
expirationTimestamp | integer <int64> Unix timestamp after witch the invitation is no longer valid |
{- "$_type": "VisitorInvitationRevokedEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "invitationId": "string",
- "conversationId": "string",
- "token": "string",
- "dateCreated": 0,
- "creatorType": "WEB_API",
- "creatorPerson": {
- "$_type": "PersonData",
- "id": "string",
- "accountId": "string",
- "personSource": "USER_DB",
- "sourceId": "string",
- "sourceData": "string",
- "firstName": "string",
- "lastName": "string",
- "username": "string",
- "nickname": "string",
- "displayName": "string",
- "personType": "AGENT",
- "authorizationRole": "SUPER_ADMIN",
- "email": "string",
- "phone": "string",
- "teamId": "string",
- "teamName": "string",
- "avatar": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}, - "email": "string",
- "nickname": "string",
- "expirationTimestamp": 0
}
$_type | string Default: "WebApiService" Value: "WebApiService" |
documentation | string Documentation of the service |
name | string Name of the service |
implementationName | string Name of the service inside unblu. Only needed to match references in documentation |
Array of objects (ResourceMetadata) [ items ] All resources of the service |
{- "$_type": "WebApiService",
- "documentation": "string",
- "name": "string",
- "implementationName": "string",
- "resources": [
- {
- "$_type": "ResourceMetadata",
- "documentation": "string",
- "requiredRole": [
- "string"
], - "requiredCallOrigin": "string",
- "path": [
- {
- "$_type": "ResourcePathElement",
- "documentation": "string",
- "name": "string",
- "dynamic": true,
- "type": "string"
}
], - "queryParameters": [
- {
- "$_type": "QueryParameter",
- "documentation": "string",
- "name": "string",
- "type": "string"
}
], - "body": {
- "$_type": "BodyElement",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- {
- "$_type": "ServiceTypeBinding",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- { }
]
}
], - "name": "string",
- "documentation": "string"
}, - "returnDocumentation": "string",
- "returnType": {
- "$_type": "ServiceTypeBinding",
- "typeName": "string",
- "isArray": true,
- "numArrayDim": 0,
- "isEnum": true,
- "typeArgs": [
- { }
]
}, - "isGetAll": true,
- "methodType": "GET"
}
]
}
$_type | string Default: "WebhookCallLog" Value: "WebhookCallLog" |
id | string Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway. |
creationTimestamp | integer <int64> Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
modificationTimestamp | integer <int64> Timestamp of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
version | integer <int64> Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted. |
accountId | string Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
registrationId | string Id of the webhook registration |
requestId | string Id of the request id created for the request to the webhook |
executionTimestamp | integer <int64> utc timestamp when the request to the webhook was executed |
endpoint | string The webhook endpoint which was requested |
retryNr | integer <int64> The number of request retries done to the webhook |
callId | string The id of the call |
eventName | string The name of the webhook event |
requestHeaders | string The request headers send with the webhook event |
requestSent | string The full send request |
requestSentTableColumn | string If the request data were larger then 2000 bytes, the first 2000 bytes are stored in this field. The other part is stored in the blob-store. See |
requestFileStoreId | string If the request data were larger then 2000 bytes, the first 2000 btes are stored in |
httpResponseCode | integer <int32> HTTP response code of the request to the webhook |
httpResponseReason | string HTTP response reason of the request to the webhook |
httpResponseHeaders | string HTTP response header of the request to the webhook |
responseFromServer | string Full Response data returned for the request to the webhook. |
responseFromServerTableColumn | string If the response to the webhook was larger then 2000 bytes, the first 2000 bytes are stored in this field. The others are stored in the |
responseMimeType | string |
responseFileStoreId | string If the response to the webhook was larger then 2000 bytes, the first 2000 bytes are stored inside |
{- "$_type": "WebhookCallLog",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "registrationId": "string",
- "requestId": "string",
- "executionTimestamp": 0,
- "endpoint": "string",
- "retryNr": 0,
- "callId": "string",
- "eventName": "string",
- "requestHeaders": "string",
- "requestSent": "string",
- "requestSentTableColumn": "string",
- "requestFileStoreId": "string",
- "httpResponseCode": 0,
- "httpResponseReason": "string",
- "httpResponseHeaders": "string",
- "responseFromServer": "string",
- "responseFromServerTableColumn": "string",
- "responseMimeType": "string",
- "responseFileStoreId": "string"
}
$_type | string Default: "WebhookCallLogOrderBy" Value: "WebhookCallLogOrderBy" |
field | string (EWebhookCallLogOrderByField) Enum: "ID" "EVENT_NAME" "REGISTRATION_ID" "REQUEST_ID" "EXECUTION_TIMESTAMP" "ENDPOINT" "RETRY_NR" "CALL_ID" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["ID: Sort by the 'id' attribute","EVENT_NAME: Sort by the 'eventName' attribute","REGISTRATION_ID: Sort by the 'registrationId' attribute","REQUEST_ID: Sort by the 'requestId' attribute","EXECUTION_TIMESTAMP: Sort by the 'executionTimestamp' attribute","ENDPOINT: Sort by the 'endpoint' attribute","RETRY_NR: Sort by the 'retryNr' attribute","CALL_ID: Sort by the 'callId' attribute","CREATION_TIMESTAMP: Sort by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Sort by the 'modificationTimestamp' attribute"] |
order | string (Order) Enum: "ASCENDING" "DESCENDING" enum-descriptions: ["ASCENDING: Sort in the ascending order (smallest to largest, 0 to 9, and/or A to Z)","DESCENDING: Sort in the descending order (largest to smallest, 9 to 0, and/or Z to A)"] |
{- "$_type": "WebhookCallLogOrderBy",
- "field": "ID",
- "order": "ASCENDING"
}
$_type | string Default: "WebhookCallLogQuery" Value: "WebhookCallLogQuery" |
Array of any (WebhookCallLogSearchFilter) [ items ] List of filters to narrow the search of entities | |
Array of objects (WebhookCallLogOrderBy) [ items ] List of criteria to order the search result list | |
offset | integer <int32> Offset position in the result set to start pagination |
limit | integer <int32> Maximal amount of items returned |
{- "$_type": "WebhookCallLogQuery",
- "searchFilters": [
- {
- "$_type": "CreationTimestampWebhookCallLogSearchFilter",
- "field": "EVENT_NAME",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
], - "orderBy": [
- {
- "$_type": "WebhookCallLogOrderBy",
- "field": "ID",
- "order": "ASCENDING"
}
], - "offset": 0,
- "limit": 0
}
$_type | string Default: "WebhookCallLogResult" Value: "WebhookCallLogResult" |
hasMoreItems | boolean Flag to indicate if there are more items on the server |
nextOffset | integer <int32> If more items are present on the server, this value can be used as offset in the next query |
Array of objects (WebhookCallLog) [ items ] The returned list of entities |
{- "$_type": "WebhookCallLogResult",
- "hasMoreItems": true,
- "nextOffset": 0,
- "items": [
- {
- "$_type": "WebhookCallLog",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "registrationId": "string",
- "requestId": "string",
- "executionTimestamp": 0,
- "endpoint": "string",
- "retryNr": 0,
- "callId": "string",
- "eventName": "string",
- "requestHeaders": "string",
- "requestSent": "string",
- "requestSentTableColumn": "string",
- "requestFileStoreId": "string",
- "httpResponseCode": 0,
- "httpResponseReason": "string",
- "httpResponseHeaders": "string",
- "responseFromServer": "string",
- "responseFromServerTableColumn": "string",
- "responseMimeType": "string",
- "responseFileStoreId": "string"
}
]
}
$_type | string Default: "CreationTimestampWebhookCallLogSearchFilter" Value: "CreationTimestampWebhookCallLogSearchFilter" |
field | string (EWebhookCallLogSearchFilterField) enum-descriptions: ["EVENT_NAME: Filter by the 'eventName' attribute","REGISTRATION_ID: Filter by the 'registrationId' attribute","REQUEST_ID: Filter by the 'requestId' attribute","EXECUTION_TIMESTAMP: Filter by the 'executionTimestamp' attribute","ENDPOINT: Filter by the 'endpoint' attribute","RETRY_NR: Filter by the 'retryNr' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","HTTP_RESPONSE_CODE: Filter by the 'httpResponseCode' attribute"] CREATION_TIMESTAMP RequestIdNameWebhookCallLogSearchFilter RegistrationIdNameWebhookCallLogSearchFilter EVENT_NAME EXECUTION_TIMESTAMP ENDPOINT RETRY_NR CREATION_TIMESTAMP HTTP_RESPONSE_CODE |
any (TimestampOperator) |
{- "$_type": "CreationTimestampWebhookCallLogSearchFilter",
- "field": "CREATION_TIMESTAMP",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
$_type | string Default: "WebhookPingEvent" Value: "WebhookPingEvent" |
timestamp | integer <int64> The time (unix time in millies) that the event was generated. |
eventType | string The name of the event |
accountId | string The account ID the event originated from. |
object (WebhookRegistration) Model of a webhook registration. Registered webhooks for certain events are stored inside this model. |
{- "$_type": "WebhookPingEvent",
- "timestamp": 0,
- "eventType": "string",
- "accountId": "string",
- "webhookConfiguration": {
- "$_type": "WebhookRegistration",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "name": "string",
- "status": "ACTIVE",
- "description": "string",
- "endpoint": "string",
- "apiVersion": "V1",
- "secret": "string",
- "events": [
- "string"
]
}
}
$_type | string Default: "WebhookRegistration" Value: "WebhookRegistration" |
id | string Unique id of the entity. When creating an entity this property can be omitted as it will be generated by the server anyway. |
creationTimestamp | integer <int64> Creation timestamp of the entity. It is defined when the entity is stored the first time in the system. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
modificationTimestamp | integer <int64> Timestamp of the last modification. This property is always optional and can be omitted, when sending data to the server. It is only of informational character. It is ignored, when sending it to the server and therefore can be omitted. Note: If you set this property it will return the same value but it will not be written to the storage and will not effect the data consistency. |
version | integer <int64> Version of the entity. Will be incremented on each change. New updates must always be based on the newest version, if not updates will be rejected. When creating an object, the version can be omitted. |
accountId | string Account id to which an entity belongs to. When creating an entity, the accountId can be omitted, as it will be filled by the server automatically with the account of the currently logged in user. When editing an entity, the accountId must be send. |
name | string Name of the webhook registration. Maximum length of 250 characters. Can not be omitted. |
status | string (ERegistrationStatus) Enum: "ACTIVE" "INACTIVE" "INACTIVE_UNAVAILABLE" enum-descriptions: ["ACTIVE: Registration is active","INACTIVE: Registration is not active","INACTIVE_UNAVAILABLE: Registration is not active, because it is unavailable"] Possible Webhook Registration Status |
description | string Description of the webhook registration. Maximum length of 500 characters. Can be omitted. |
endpoint | string The endpoint url of the webhook registration. To this url the requests for the webhook events are done. Maximum length of 4000 characters. Can be omitted, but should not. |
apiVersion | string (EWebApiVersion) Enum: "V1" "V2" "V3" enum-descriptions: ["V1: Version 1 of the Web-API. Introduced with Unblu 4.x.","V2: Version 2 of the Web-API. Introduced with Unblu 5.","V3: Version 3 of the Web-API. Introduced with Unblu 6."] Version of the Web-API. Version of API corresponds to a path element of the request URL. E.g.: /rest/v3/<service>/... |
secret | string A secret which is send with each webhook event. Maximum length of 4000 characters. Can be omitted. |
events | Array of strings Events for which the webhook endpoint is called, if they occur. Can not be omitted. Check the Webhook Events for possible values. |
{- "$_type": "WebhookRegistration",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "name": "string",
- "status": "ACTIVE",
- "description": "string",
- "endpoint": "string",
- "apiVersion": "V1",
- "secret": "string",
- "events": [
- "string"
]
}
$_type | string Default: "WebhookRegistrationOrderBy" Value: "WebhookRegistrationOrderBy" |
field | string (EWebhookRegistrationOrderByField) Enum: "ID" "NAME" "STATUS" "DESCRIPTION" "ENDPOINT" "API_VERSION" "CREATION_TIMESTAMP" "MODIFICATION_TIMESTAMP" enum-descriptions: ["ID: Sort by the 'id' attribute","NAME: Sort by the 'name' attribute","STATUS: Sort by the 'status' attribute","DESCRIPTION: Sort by the 'description' attribute","ENDPOINT: Sort by the 'endpoint' attribute","API_VERSION: Sort by the 'apiVersion' attribute","CREATION_TIMESTAMP: Sort by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Sort by the 'modificationTimestamp' attribute"] |
order | string (Order) Enum: "ASCENDING" "DESCENDING" enum-descriptions: ["ASCENDING: Sort in the ascending order (smallest to largest, 0 to 9, and/or A to Z)","DESCENDING: Sort in the descending order (largest to smallest, 9 to 0, and/or Z to A)"] |
{- "$_type": "WebhookRegistrationOrderBy",
- "field": "ID",
- "order": "ASCENDING"
}
$_type | string Default: "WebhookRegistrationQuery" Value: "WebhookRegistrationQuery" |
Array of any (WebhookRegistrationSearchFilter) [ items ] List of filters to narrow the search of entities | |
Array of objects (WebhookRegistrationOrderBy) [ items ] List of criteria to order the search result list | |
offset | integer <int32> Offset position in the result set to start pagination |
limit | integer <int32> Maximal amount of items returned |
{- "$_type": "WebhookRegistrationQuery",
- "searchFilters": [
- {
- "$_type": "CreationTimestampWebhookRegistrationSearchFilter",
- "field": "NAME",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}
], - "orderBy": [
- {
- "$_type": "WebhookRegistrationOrderBy",
- "field": "ID",
- "order": "ASCENDING"
}
], - "offset": 0,
- "limit": 0
}
$_type | string Default: "WebhookRegistrationResult" Value: "WebhookRegistrationResult" |
hasMoreItems | boolean Flag to indicate if there are more items on the server |
nextOffset | integer <int32> If more items are present on the server, this value can be used as offset in the next query |
Array of objects (WebhookRegistration) [ items ] The returned list of entities |
{- "$_type": "WebhookRegistrationResult",
- "hasMoreItems": true,
- "nextOffset": 0,
- "items": [
- {
- "$_type": "WebhookRegistration",
- "id": "string",
- "creationTimestamp": 0,
- "modificationTimestamp": 0,
- "version": 0,
- "accountId": "string",
- "name": "string",
- "status": "ACTIVE",
- "description": "string",
- "endpoint": "string",
- "apiVersion": "V1",
- "secret": "string",
- "events": [
- "string"
]
}
]
}
$_type | string Default: "CreationTimestampWebhookRegistrationSearchFilter" Value: "CreationTimestampWebhookRegistrationSearchFilter" |
field | string (EWebhookRegistrationSearchFilterField) enum-descriptions: ["NAME: Sort by the 'name' attribute","DESCRIPTION: Sort by the 'description' attribute","ENDPOINT: Sort by the 'endpoint' attribute","CREATION_TIMESTAMP: Filter by the 'creationTimestamp' attribute","MODIFICATION_TIMESTAMP: Filter by the 'modificationTimestamp' attribute"] CREATION_TIMESTAMP NAME DESCRIPTION ENDPOINT CREATION_TIMESTAMP MODIFICATION_TIMESTAMP |
any (TimestampOperator) |
{- "$_type": "CreationTimestampWebhookRegistrationSearchFilter",
- "field": "CREATION_TIMESTAMP",
- "operator": {
- "$_type": "EqualsTimestampOperator",
- "type": "EQUALS",
- "value": 0
}
}