Returns an agent group list from an application

get https://api.indigitall.com/v1/chat/agent/group

time	status	user agent
Retrieving recent requests…

Loading…

Responses

Response body

object

statusCode

integer

required

Response code

errorCode

string

Sort order:

AUTH_ERROR - Authorization error
TOO_MANY_REQUESTS - TOO_MANY_REQUESTS
IP_WHITELIST - The ip with which you are trying to access the resource is not allowed
PS_INTERNAL_ERROR - Internal Server Error
PS_FORBIDDEN - Forbidden action
PS_BAD_REQUEST - Generic bad request
PS_ARGUMENTS - Error in any of the arguments
PS_DATE_FORMAT - The specified date format is not correct
PS_DATE_RANGE - It indicated a range of dates not allowed
PS_DATE_RANGE_MAX - Indicates that the range between two dates exceeds the maximum limit
PS_INVALID_TOPIC_CODE - The topic code has a wrong format
PS_TOPIC_NOT_FOUND - The topic code has a wrong format
PS_APPLICATION_NOT_FOUND - Application / project not found
PS_CAMPAIGN_NOT_FOUND - Campaign not found
PS_CAMPAIGN_NOT_MODIFIABLE - Campaign cannot be updated as it belongs to an initialized journey
PS_TEST_NOT_FOUND - Test not found
PS_MULTITEST_NOT_FOUND - Multitest not found
PS_INAPPSCHEMA_NOT_FOUND - InApp schema not found
PS_INAPP_NOT_FOUND - InApp not found
PS_SENDING_NOT_FOUND - Sending not found
PS_SENDING_ALREADY_CANCELLED - Sending already cancelled or has a past date scheduled
PS_CSV_EMPTY - The CSV has a wrong format: it is empty
PS_CSV_FIELD_NOT_FOUND - The CSV has a wrong format: a required field is missing
PS_CSV_SIZE - The CSV has an impermissible size
PS_BAD_CSV_FORMAT - Generic CSV format error
PS_CAMPAIGN_TIMEZONE - The property Timezone camapaña has an incorrect value
PS_CAMPAIGN_ACTION - There was an error trying to process the actions of the campaign
PS_CAMPAIGN_BUTTON - There was an error trying to process the campaign buttons
PS_CAMPAIGN_TRIGGER - There was an error trying to process the triggers of the campaign
PS_CAMPAIGN_OVERWRITE_PROPERTIES - There was an error trying to process the properties overwrite campaign
PS_CAMPAIGN_BAD_VIDEO - There was an error trying to process the video of the campaign
PS_CAMPAIGN_BAD_VIDEO_TYPE - There was an error trying to process the video of the campaign. Video type is not allowed.
PS_CAMPAIGN_BAD_VIDEO_SIZE - There was an error trying to process the video of the campaign. The size of the video exceeds the maximum allowable size.
PS_CAMPAIGN_BAD_VIDEO_SIZE_AFTER_CONVERSION - There was an error trying to process the video of the campaign. The size of the video then convert it exceeds the maximum allowable size.
PS_CAMPAIGN_BAD_WALLET_TYPE - There was an error trying to process the wallet of the campaign. The type of wallet is invalid.
PS_CAMPAIGN_BAD_WALLET_SIZE - There was an error trying to process the wallet of the campaign. The size of the wallet is invalid.
PS_CAMPAIGN_BAD_ICON_TYPE - There was an error trying to process the icon of the campaign. The type of icon is invalid.
PS_CAMPAIGN_BAD_ICON_SIZE - There was an error trying to process the icon of the campaign. The size of the icon is invalid.
PS_CAMPAIGN_TARGETS - There was an error trying to process the targets of the campaign
PS_FEATURE_GEOFENCING_DISABLED - The feature 'gefencing' is disabled for this account
PS_FEATURE_NETWORK_DISABLED - The feature 'network' is disabled for this account
PS_MULTITEST_INVALID - The test contains invalid data
PS_MULTITEST_ALREADY_SENT - The multitest has already been sent
PS_INAPP_DISABLED - inApp and inWeb are disabled in this application
PS_INAPPSCHEMA_CODE_INVALID - The code for this inappSchema has an incorrect format
PS_INAPPSCHEMA_CODE_ALREADY_EXISTS - The code for this inappSchema is already being used
PS_INAPP_START_DATE_INVALID - Start date in inapp is invalid
PS_INAPP_END_DATE_INVALID - End date in inapp is invalid
PS_BAD_IMAGE_TYPE - Image has invalid format
PS_BAD_IMAGE_SIZE - Image has invalid size
PS_TEST_INVALID - This test is not valid on this endpoint or has invalid configuration
PS_TEST_ALREADY_SENT - The test has already been sent
PS_CAMPAIGN_CUSTOMER_SERVICE - Campaigns with the onlyCustomerService field set to true cannot use triggers or filtering other than platform
PS_CAMPAIGN_CUSTOMER_SERVICE_SENDING - Campaigns with the onlyCustomerService field set to true can only be sent from a journey.
Customer service can only send campaigns with this field set to true.
PS_CAMPAIGN_INVALID_CATEGORY_ID - The category id indicated in a campaign is invalid, does not exist or belongs to another application
PS_EXTRACT_META_PARSE_HTML_ERROR - Error during meta tag extraction due to HTML parsing failure
AS_INTERNAL_ERROR - Generic internal error
AS_FORBIDDEN - Generic forbidden error
AS_BAD_REQUEST - Generic bad request
AS_LIMIT_EXCEEDED - Some of the configured limits have been exceeded
AS_INVALID_CREDENTIALS - Invalid credentials
AS_ELEMENT_NOT_FOUND - Element not found
AS_LOCKED_INACTIVITY - User is locked for inactivity. Please, contact an administrator
AS_LOCKED_EXPIRED_PASSWORD - The password is way old. Please, change it for a new one
AS_LOCKED_TOO_MANY_LOGIN_ATTEMPTS - Too many login attempts
AS_APPLICATION_NOT_FOUND - Application (project) not found
AS_ACCOUNT_NOT_FOUND - Account not found
AS_EXTERNAL_APP_NOT_FOUND -
AS_AREA_NOT_FOUND -
AS_WEB_ANALYTIC_NOT_FOUND -
AS_CATEGORY_NOT_FOUND -
AS_EXTERNAL_AUTH_NOT_FOUND -
AS_USER_NOT_FOUND -
AS_INTEGRATION_NOT_FOUND -
AS_PERMISSION_NOT_FOUND -
AS_ROLE_NOT_FOUND -
AS_IP_WHITELIST- The ip with which you are trying to access the resource is not allowed
AS_CHAT_FEATURE_DISABLED - Chat Service is not activated for this account
AS_CONTACT_CENTER_FEATURE_DISABLED - Contact Center is not activated for this account
AS_RESOURCE_ALREADY_EXISTS - Generic error when trying to duplicate a resource
AS_EMAIL_ALREADY_EXISTS - User with same email already exists
AS_TOPIC_ALREADY_EXISTS - Topic code already exists in this application
AS_CATEGORY_ALREADY_EXISTS - Category code already exists in this application
AS_USER_ALREADY_EXISTS - User already exists
AS_SAFARI_ID_ALREADY_EXISTS - Safari push ID already exists
AS_EXTERNAL_AUTH_DATA_ALREADY_EXISTS - External auth already exists
AS_TOPIC_PARENT_NOT_FOUND - Topic parent not found
AS_INVALID_CERTIFICATE - Invalid certificate credentials or invalid certificate
AS_PASSWORD_MISMATCH - currentPassword does not match with user current password'
AS_PASSWORD_SAME_OLD - Old and new password shoud be different
AS_BAD_SAFARI_CONFIGURATION - It has been requested to activate Safari push, however, the necessary parameters for this service has not been provided.
AS_BAD_HARMONY_CONFIGURATION - It has been requested to activate Harmony push, however, the necessary parameters for this service has not been provided.
AS_BAD_ANDROID_CONFIGURATION - It has been requested to activate Android push, however, the necessary parameters for this service has not been provided.
AS_BAD_REPORTING_CONFIGURATION - Reporting configuration object does not have the expected format
AS_BAD_SLICING_CONFIGURATION - Slicing configuration object does not have the expected format
AS_BAD_APP_CODE - App code does not have the expected format
AS_BAD_TOPIC_CODE - Topic code does not have the expected format
AS_BAD_IMAGE_TYPE - Image format is different than expected
AS_BAD_IMAGE_SIZE - Image file size exceeds maximum size
AS_BAD_CSV_FORMAT - The format of the CSV file is not as expected. It may be empty or may not contain the expected columns or headers.
AS_BAD_EMAIL - Email was not found or is in the wrong format
AS_BAD_PASSWORD - Password was not found or is in the wrong format
AS_PASSWORD_MANDATORY - Password field is mandatory and cannot be empty
AS_ONLY_SUPER_ADMIN_PERMISSION - Only super administrator has permission to perform this action
AS_INVALID_METHOD - The totp method is not valid
AS_INVALID_TOTP - The totp code is not valid
AS_INVALID_TOKEN - The JWT user is not the same that body user.
AS_CHAT_DOWNLOAD_ACCOUNTS_FEATURE_DISABLED - download contacts is not active in this account.
CS_CSV_NUMBER_OF_PARAMS - Number of incorrect parameters
CS_CSV_EMPTY_FILE - Empty file or no data
CS_CSV_INVALID_CHANNEL - Only Whatsapp channel is allowed
CS_CSV_INVALID_CONTENT_TYPE - Invalid contentType. Only template contentType is available
CS_CSV_INVALID_PARAMETER - Invalid parameter
CS_CSV_INVALID_TYPE - Invalid file type
CS_CSV_MISSING_FIELDS - Missings fields
CS_CSV_EMPTY_FIELDS - Empty fields
CS_DOWNLOAD_MULTIMEDIA_ERROR - Error in download file by URL

AUTH_ERROR TOO_MANY_REQUESTS IP_WHITELIST PS_INTERNAL_ERROR PS_FORBIDDEN PS_BAD_REQUEST PS_ARGUMENTS PS_DATE_FORMAT PS_DATE_RANGE PS_DATE_RANGE_MAX PS_INVALID_TOPIC_CODE PS_TOPIC_NOT_FOUND PS_APPLICATION_NOT_FOUND PS_CAMPAIGN_NOT_FOUND PS_TEST_NOT_FOUND PS_MULTITEST_NOT_FOUND PS_INAPPSCHEMA_NOT_FOUND PS_INAPP_NOT_FOUND PS_SENDING_NOT_FOUND PS_SENDING_ALREADY_CANCELLED PS_CSV_EMPTY PS_CSV_FIELD_NOT_FOUND PS_CSV_SIZE PS_BAD_CSV_FORMAT PS_CAMPAIGN_TIMEZONE PS_CAMPAIGN_ACTION PS_CAMPAIGN_BUTTON PS_CAMPAIGN_TRIGGER PS_CAMPAIGN_OVERWRITE_PROPERTIES PS_CAMPAIGN_BAD_VIDEO PS_CAMPAIGN_BAD_VIDEO_TYPE PS_CAMPAIGN_BAD_VIDEO_SIZE PS_CAMPAIGN_BAD_VIDEO_SIZE_AFTER_CONVERSION PS_CAMPAIGN_BAD_WALLET_TYPE PS_CAMPAIGN_BAD_WALLET_SIZE PS_CAMPAIGN_BAD_ICON_TYPE PS_CAMPAIGN_BAD_ICON_SIZE PS_CAMPAIGN_TARGETS PS_FEATURE_GEOFENCING_DISABLED PS_FEATURE_NETWORK_DISABLED PS_MULTITEST_INVALID PS_MULTITEST_ALREADY_SENT PS_INAPP_DISABLED PS_INAPPSCHEMA_CODE_INVALID PS_INAPPSCHEMA_CODE_ALREADY_EXISTS PS_INAPP_START_DATE_INVALID PS_INAPP_END_DATE_INVALID PS_BAD_IMAGE_TYPE PS_BAD_IMAGE_SIZE PS_CAMPAIGN_CUSTOMER_SERVICE PS_CAMPAIGN_CUSTOMER_SERVICE_SENDING PS_CAMPAIGN_INVALID_CATEGORY_ID PS_EXTRACT_META_PARSE_HTML_ERROR AS_INTERNAL_ERROR AS_FORBIDDEN AS_BAD_REQUEST AS_LIMIT_EXCEEDED AS_INVALID_CREDENTIALS AS_ELEMENT_NOT_FOUND AS_LOCKED_INACTIVITY AS_LOCKED_EXPIRED_PASSWORD AS_LOCKED_TOO_MANY_LOGIN_ATTEMPTS AS_APPLICATION_NOT_FOUND AS_ACCOUNT_NOT_FOUND AS_EXTERNAL_APP_NOT_FOUND AS_AREA_NOT_FOUND AS_WEB_ANALYTIC_NOT_FOUND AS_CATEGORY_NOT_FOUND AS_EXTERNAL_AUTH_NOT_FOUND AS_USER_NOT_FOUND AS_INTEGRATION_NOT_FOUND AS_PERMISSION_NOT_FOUND AS_ROLE_NOT_FOUND AS_IP_WHITELIST AS_CHAT_FEATURE_DISABLED AS_CONTACT_CENTER_FEATURE_DISABLED AS_RESOURCE_ALREADY_EXISTS AS_EMAIL_ALREADY_EXISTS AS_TOPIC_ALREADY_EXISTS AS_CATEGORY_ALREADY_EXISTS AS_USER_ALREADY_EXISTS AS_SAFARI_ID_ALREADY_EXISTS AS_EXTERNAL_AUTH_DATA_ALREADY_EXISTS AS_TOPIC_PARENT_NOT_FOUND AS_INVALID_CERTIFICATE AS_PASSWORD_MISMATCH AS_PASSWORD_SAME_OLD AS_BAD_SAFARI_CONFIGURATION AS_BAD_HARMONY_CONFIGURATION AS_BAD_ANDROID_CONFIGURATION AS_BAD_REPORTING_CONFIGURATION AS_BAD_SLICING_CONFIGURATION AS_BAD_APP_CODE AS_BAD_TOPIC_CODE AS_BAD_IMAGE_TYPE AS_BAD_IMAGE_SIZE AS_BAD_CSV_FORMAT AS_BAD_EMAIL AS_BAD_PASSWORD AS_PASSWORD_MANDATORY PS_TEST_INVALID PS_TEST_ALREADY_SENT AS_ONLY_SUPER_ADMIN_PERMISSION AS_INVALID_METHOD AS_INVALID_TOTP AS_INVALID_TOKEN AS_CHAT_DOWNLOAD_ACCOUNTS_FEATURE_DISABLED CS_CSV_NUMBER_OF_PARAMS CS_CSV_EMPTY_FILE CS_CSV_INVALID_CHANNEL CS_CSV_INVALID_CONTENT_TYPE CS_CSV_INVALID_PARAMETER CS_CSV_INVALID_TYPE CS_CSV_MISSING_FIELDS CS_CSV_EMPTY_FIELDS CS_DOWNLOAD_MULTIMEDIA_ERROR

message

string

required

Error message

Response body

object

statusCode

integer

required

Response code

errorCode

string

Sort order:

AUTH_ERROR - Authorization error
TOO_MANY_REQUESTS - TOO_MANY_REQUESTS
IP_WHITELIST - The ip with which you are trying to access the resource is not allowed
PS_INTERNAL_ERROR - Internal Server Error
PS_FORBIDDEN - Forbidden action
PS_BAD_REQUEST - Generic bad request
PS_ARGUMENTS - Error in any of the arguments
PS_DATE_FORMAT - The specified date format is not correct
PS_DATE_RANGE - It indicated a range of dates not allowed
PS_DATE_RANGE_MAX - Indicates that the range between two dates exceeds the maximum limit
PS_INVALID_TOPIC_CODE - The topic code has a wrong format
PS_TOPIC_NOT_FOUND - The topic code has a wrong format
PS_APPLICATION_NOT_FOUND - Application / project not found
PS_CAMPAIGN_NOT_FOUND - Campaign not found
PS_CAMPAIGN_NOT_MODIFIABLE - Campaign cannot be updated as it belongs to an initialized journey
PS_TEST_NOT_FOUND - Test not found
PS_MULTITEST_NOT_FOUND - Multitest not found
PS_INAPPSCHEMA_NOT_FOUND - InApp schema not found
PS_INAPP_NOT_FOUND - InApp not found
PS_SENDING_NOT_FOUND - Sending not found
PS_SENDING_ALREADY_CANCELLED - Sending already cancelled or has a past date scheduled
PS_CSV_EMPTY - The CSV has a wrong format: it is empty
PS_CSV_FIELD_NOT_FOUND - The CSV has a wrong format: a required field is missing
PS_CSV_SIZE - The CSV has an impermissible size
PS_BAD_CSV_FORMAT - Generic CSV format error
PS_CAMPAIGN_TIMEZONE - The property Timezone camapaña has an incorrect value
PS_CAMPAIGN_ACTION - There was an error trying to process the actions of the campaign
PS_CAMPAIGN_BUTTON - There was an error trying to process the campaign buttons
PS_CAMPAIGN_TRIGGER - There was an error trying to process the triggers of the campaign
PS_CAMPAIGN_OVERWRITE_PROPERTIES - There was an error trying to process the properties overwrite campaign
PS_CAMPAIGN_BAD_VIDEO - There was an error trying to process the video of the campaign
PS_CAMPAIGN_BAD_VIDEO_TYPE - There was an error trying to process the video of the campaign. Video type is not allowed.
PS_CAMPAIGN_BAD_VIDEO_SIZE - There was an error trying to process the video of the campaign. The size of the video exceeds the maximum allowable size.
PS_CAMPAIGN_BAD_VIDEO_SIZE_AFTER_CONVERSION - There was an error trying to process the video of the campaign. The size of the video then convert it exceeds the maximum allowable size.
PS_CAMPAIGN_BAD_WALLET_TYPE - There was an error trying to process the wallet of the campaign. The type of wallet is invalid.
PS_CAMPAIGN_BAD_WALLET_SIZE - There was an error trying to process the wallet of the campaign. The size of the wallet is invalid.
PS_CAMPAIGN_BAD_ICON_TYPE - There was an error trying to process the icon of the campaign. The type of icon is invalid.
PS_CAMPAIGN_BAD_ICON_SIZE - There was an error trying to process the icon of the campaign. The size of the icon is invalid.
PS_CAMPAIGN_TARGETS - There was an error trying to process the targets of the campaign
PS_FEATURE_GEOFENCING_DISABLED - The feature 'gefencing' is disabled for this account
PS_FEATURE_NETWORK_DISABLED - The feature 'network' is disabled for this account
PS_MULTITEST_INVALID - The test contains invalid data
PS_MULTITEST_ALREADY_SENT - The multitest has already been sent
PS_INAPP_DISABLED - inApp and inWeb are disabled in this application
PS_INAPPSCHEMA_CODE_INVALID - The code for this inappSchema has an incorrect format
PS_INAPPSCHEMA_CODE_ALREADY_EXISTS - The code for this inappSchema is already being used
PS_INAPP_START_DATE_INVALID - Start date in inapp is invalid
PS_INAPP_END_DATE_INVALID - End date in inapp is invalid
PS_BAD_IMAGE_TYPE - Image has invalid format
PS_BAD_IMAGE_SIZE - Image has invalid size
PS_TEST_INVALID - This test is not valid on this endpoint or has invalid configuration
PS_TEST_ALREADY_SENT - The test has already been sent
PS_CAMPAIGN_CUSTOMER_SERVICE - Campaigns with the onlyCustomerService field set to true cannot use triggers or filtering other than platform
PS_CAMPAIGN_CUSTOMER_SERVICE_SENDING - Campaigns with the onlyCustomerService field set to true can only be sent from a journey.
Customer service can only send campaigns with this field set to true.
PS_CAMPAIGN_INVALID_CATEGORY_ID - The category id indicated in a campaign is invalid, does not exist or belongs to another application
PS_EXTRACT_META_PARSE_HTML_ERROR - Error during meta tag extraction due to HTML parsing failure
AS_INTERNAL_ERROR - Generic internal error
AS_FORBIDDEN - Generic forbidden error
AS_BAD_REQUEST - Generic bad request
AS_LIMIT_EXCEEDED - Some of the configured limits have been exceeded
AS_INVALID_CREDENTIALS - Invalid credentials
AS_ELEMENT_NOT_FOUND - Element not found
AS_LOCKED_INACTIVITY - User is locked for inactivity. Please, contact an administrator
AS_LOCKED_EXPIRED_PASSWORD - The password is way old. Please, change it for a new one
AS_LOCKED_TOO_MANY_LOGIN_ATTEMPTS - Too many login attempts
AS_APPLICATION_NOT_FOUND - Application (project) not found
AS_ACCOUNT_NOT_FOUND - Account not found
AS_EXTERNAL_APP_NOT_FOUND -
AS_AREA_NOT_FOUND -
AS_WEB_ANALYTIC_NOT_FOUND -
AS_CATEGORY_NOT_FOUND -
AS_EXTERNAL_AUTH_NOT_FOUND -
AS_USER_NOT_FOUND -
AS_INTEGRATION_NOT_FOUND -
AS_PERMISSION_NOT_FOUND -
AS_ROLE_NOT_FOUND -
AS_IP_WHITELIST- The ip with which you are trying to access the resource is not allowed
AS_CHAT_FEATURE_DISABLED - Chat Service is not activated for this account
AS_CONTACT_CENTER_FEATURE_DISABLED - Contact Center is not activated for this account
AS_RESOURCE_ALREADY_EXISTS - Generic error when trying to duplicate a resource
AS_EMAIL_ALREADY_EXISTS - User with same email already exists
AS_TOPIC_ALREADY_EXISTS - Topic code already exists in this application
AS_CATEGORY_ALREADY_EXISTS - Category code already exists in this application
AS_USER_ALREADY_EXISTS - User already exists
AS_SAFARI_ID_ALREADY_EXISTS - Safari push ID already exists
AS_EXTERNAL_AUTH_DATA_ALREADY_EXISTS - External auth already exists
AS_TOPIC_PARENT_NOT_FOUND - Topic parent not found
AS_INVALID_CERTIFICATE - Invalid certificate credentials or invalid certificate
AS_PASSWORD_MISMATCH - currentPassword does not match with user current password'
AS_PASSWORD_SAME_OLD - Old and new password shoud be different
AS_BAD_SAFARI_CONFIGURATION - It has been requested to activate Safari push, however, the necessary parameters for this service has not been provided.
AS_BAD_HARMONY_CONFIGURATION - It has been requested to activate Harmony push, however, the necessary parameters for this service has not been provided.
AS_BAD_ANDROID_CONFIGURATION - It has been requested to activate Android push, however, the necessary parameters for this service has not been provided.
AS_BAD_REPORTING_CONFIGURATION - Reporting configuration object does not have the expected format
AS_BAD_SLICING_CONFIGURATION - Slicing configuration object does not have the expected format
AS_BAD_APP_CODE - App code does not have the expected format
AS_BAD_TOPIC_CODE - Topic code does not have the expected format
AS_BAD_IMAGE_TYPE - Image format is different than expected
AS_BAD_IMAGE_SIZE - Image file size exceeds maximum size
AS_BAD_CSV_FORMAT - The format of the CSV file is not as expected. It may be empty or may not contain the expected columns or headers.
AS_BAD_EMAIL - Email was not found or is in the wrong format
AS_BAD_PASSWORD - Password was not found or is in the wrong format
AS_PASSWORD_MANDATORY - Password field is mandatory and cannot be empty
AS_ONLY_SUPER_ADMIN_PERMISSION - Only super administrator has permission to perform this action
AS_INVALID_METHOD - The totp method is not valid
AS_INVALID_TOTP - The totp code is not valid
AS_INVALID_TOKEN - The JWT user is not the same that body user.
AS_CHAT_DOWNLOAD_ACCOUNTS_FEATURE_DISABLED - download contacts is not active in this account.
CS_CSV_NUMBER_OF_PARAMS - Number of incorrect parameters
CS_CSV_EMPTY_FILE - Empty file or no data
CS_CSV_INVALID_CHANNEL - Only Whatsapp channel is allowed
CS_CSV_INVALID_CONTENT_TYPE - Invalid contentType. Only template contentType is available
CS_CSV_INVALID_PARAMETER - Invalid parameter
CS_CSV_INVALID_TYPE - Invalid file type
CS_CSV_MISSING_FIELDS - Missings fields
CS_CSV_EMPTY_FIELDS - Empty fields
CS_DOWNLOAD_MULTIMEDIA_ERROR - Error in download file by URL

message

string

required

Error message

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.indigitall.com/v1/chat/agent/group \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

400Parameters missing or not in right format

500Server error