SCALAR
String
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
link GraphQL Schema definition
- scalar String
link Require by
- AppleBusinessChatMessageExtensionAttachmentAn Apple Business Chat iMessage extension attachment
- ApplePayLineItemAttachmentTypeAn apple pay line item that explains recurring payments and additional charges and discounts attachment
- ApplePayPaymentAttachmentAn Apple Pay payment attachment
- ApplePayShippingMethodAttachmentTypeAn Apple Pay shipping method for delivering physical goods attachment
- AutomaticMessageSentSystemAttachmentParticipant returned event
- BotSome bot that interacts with visitors.
- CallConfigurationConfiguration for the call channel
- CallConfigurationInputConfiguration for the call channel
- CallConfigurationUpdateConfiguration for the call channel
- CannotChangeOwnRoleProfessionalUpdateUserErrorError returned by the professionalUpdate mutation when the calling user attempts to change their own role.
- CardAttachmentCard type
- CardBundleAttachmentA cardBundle attachment
- Categorynull
- ChatAndCallWithDisabledCallErrorThe "chat and call" option is enabled while having the call channel disabled
- ChatToVideoWithDisabledVideoErrorThe "chat to video" option is enabled while having the video channel disabled
- Clientnull
- ClientEdgeAn edge in a connection.
- ClosedConversationFiltersFilters on the ClosedConversation resource (indexed conversation)
- CommunitySettingsCommunity settings
- ConnectedUserFiltersCriteria available to filter a list of connected users.
- ConnectorConnector
- ConnectorConversationClosingFormValueConversation closing form value type
- ConnectorEdgeAn edge in a connection.
- ConnectorVersionConnector version
- ConnectorVersionEdgeAn edge in a connection.
- ConnectorVersionInstallationEdgeAn edge in a connection.
- ConnectorVersionParameterParameter for connector version
- ConnectorVersionParameterValueTextParameter value for a connector version
- ContextualInfosAttachmentA contexualInfos attachment
- Conversationnull
- ConversationMessageAttachmentImageLinkSimple image type
- ConversationMessageAttachmentLinkActionConversation Link Action type
- ConversationMessageAttachmentSelectActionConversation Select Action type
- ConversationMessageEdgeAn edge in a connection.
- ConversationTagnull
- ConversationTagEdgeAn edge in a connection.
- ConversationTagInputnull
- ConversationVisitornull
- ConversationVisitorEdgeAn edge in a connection.
- CountryPreferencesLocation-related preferences of a user
- CountryPreferencesInputLocation-related preferences of a user
- CountryPreferencesUpdateInputLocation-related preferences of a user
- DeveloperExternal or internal developer that implements applications that interact with iAdvize
- EmailAlreadyUsedErrorThe email provided is already used
- EmailAlreadyUsedProfessionalCreateUserErrorError returned by the professionalCreate mutation when the provided email is already used by another user.
- EmailAlreadyUsedProfessionalUpdateUserErrorError returned by the professionalUpdate mutation when the provided email is already used by another user.
- EngagementRuleTriggeredSystemAttachmentEngagement rule triggered event
- ExpertAn ambassador who interacts with visitors.
- ExternalIdIsEmptyErrorMissing value for the external-id
- ExternalIdIsEmptyProfessionalCreateUserErrorError returned by the professionalCreate mutation when the provided external id is empty.
- ExternalIdIsEmptyProfessionalSetExternalIdUserErrorError returned by the professionalSetExternalId mutation when the provided group id is invalid.
- FileAttachmentA file attachment
- FirstNameIsEmptyErrorMissing value for the first name
- FirstNameIsEmptyProfessionalCreateUserErrorError returned by the professionalCreate mutation when the provided first name is empty.
- FirstNameIsEmptyProfessionalUpdateUserErrorError returned by the professionalUpdate mutation when the provided first name is empty.
- IbbuManagerAn Ibbu manager user internal to iAdvize
- ImageAttachmentAn image attachment
- IncompatibleAskForNumberChoiceErrorThe "ask for number" option is enabled while having "respond from" = DESK
- InvalidAvatarUrlErrorThe provided avatar is not a valid url
- InvalidAvatarURLProfessionalCreateUserErrorError returned by the professionalCreate mutation when the provided avatar URL is invalid.
- InvalidEmailErrorThe provided email is not valid
- InvalidEmailProfessionalCreateUserErrorError returned by the professionalCreate mutation when the provided email is invalid.
- InvalidEmailProfessionalUpdateUserErrorError returned by the professionalUpdate mutation when the provided email is invalid.
- InvalidGroupIdErrorThe group-id provided is invalid
- InvalidGroupIdProfessionalCreateUserErrorError returned by the professionalCreate mutation when the provided group id is invalid.
- InvalidGroupIdProfessionalSetGroupUserErrorError returned by the professionalSetGroup mutation when the provided group id is invalid.
- InvalidInterfaceLanguageErrorThe provided interface language is not supported
- InvalidInterfaceLanguageProfessionalCreateUserErrorError returned by the professionalCreate mutation when the provided interface language is invalid.
- InvalidInterfaceLanguageProfessionalUpdateUserErrorError returned by the professionalUpdate mutation when the provided interface language is invalid.
- InvalidNumberOfSlotsForChatErrorThe provided number of slots for the chat channel is invalid
- InvalidNumberOfSlotsForThirdPartiesErrorThe provided number of slots for the third-parties channel is invalid
- InvalidPasswordErrorThe provided password is not valid
- InvalidPasswordProfessionalCreateUserErrorError returned by the professionalCreate mutation when the provided password is invalid.
- InvalidPasswordProfessionalUpdateUserErrorError returned by the professionalUpdate mutation when the provided password is invalid.
- InvalidPhoneNumberErrorThe provided phone number is not valid
- InvalidPriorityValueErrorThe provided priority is invalid for the concerned channel
- InvalidProjectIdErrorThe project-id provided is invalid
- InvalidProjectIdProfessionalCreateUserErrorError returned by the professionalCreate mutation when a provided project id is invalid.
- InvalidProjectIdProfessionalSetProjectsUserErrorError returned by the professionalSetProjects mutation when a provided project id is invalid.
- InvalidRoleErrorThe role-id provided is invalid
- InvalidRoleProfessionalCreateUserErrorError returned by the professionalCreate mutation when the provided role name is invalid.
- InvalidRoleProfessionalUpdateUserErrorError returned by the professionalUpdate mutation when the provided role name is invalid.
- InvalidSkillIdErrorA provided skill-id is invalid
- InvalidSkillIdProfessionalCreateUserErrorError returned by the professionalCreate mutation when a provided skill id is invalid.
- InvalidSkillIdProfessionalSetSkillsUserErrorError returned by the professionalSetSkills mutation when a provided skill id is invalid.
- InvalidSpokenLanguageErrorA provided spoken language is not supported
- InvalidSpokenLanguageProfessionalCreateUserErrorError returned by the professionalCreate mutation when a provided spoken language is invalid.
- InvalidSpokenLanguageProfessionalUpdateUserErrorError returned by the professionalUpdate mutation when a provided spoken language is invalid.
- LastNameIsEmptyErrorMissing value for the last name
- LastNameIsEmptyProfessionalCreateUserErrorError returned by the professionalCreate mutation when the provided last name is empty.
- LastNameIsEmptyProfessionalUpdateUserErrorError returned by the professionalUpdate mutation when the provided last name is empty.
- LinkAttachmentA link attachment
- ListPickerAttachmentItemA list picker item
- ListPickerAttachmentSectionA list picker section
- LocationLocation
- LocationAttachmentA geographical location
- LocationCreateInputInput to create a new location
- LocationUpdateInputInput to update a location
- MessageTranslationMessage translation entry
- MessengerFontA font used for notification or chatbox
- MessengerFontEdgeAn edge in a connection.
- NotAProfessionalUserIdProfessionalSetExternalIdUserErrorError returned by the professionalSetExternalId mutation when the provided user id targets a user who is not a professional user.
- NotAProfessionalUserIdProfessionalSetGroupUserErrorError returned by the professionalSetGroup mutation when the provided user id targets a user who is not a professional user.
- NotAProfessionalUserIdProfessionalSetProjectsUserErrorError returned by the professionalSetProjects mutation when the provided user id targets a user who is not a professional user.
- NotAProfessionalUserIdProfessionalSetSkillsUserErrorError returned by the professionalSetSkills mutation when the provided user id targets a user who is not a professional user.
- NotAProfessionalUserIdProfessionalUnsetExternalIdUserErrorError returned by the professionalUnsetExternalId mutation when the provided user id targets a user who is not a professional user.
- NotAProfessionalUserIdProfessionalUnsetGroupUserErrorError returned by the professionalUnsetGroup mutation when the provided user id targets a user who is not a professional user.
- NotAProfessionalUserIdProfessionalUpdateUserErrorError returned by the professionalUpdate mutation when the provided user id targets a user who is not a professional user.
- NotificationSettingsNotification settings
- OfferAttachmentAn offer attachment
- OutboundMessageSentSystemAttachmentOutbound message sent to the visitor
- PageInfoInformation about pagination in a connection.
- ParticipantConversationMessageParticipant conversation's message
- PasswordNotSetErrorMissing password
- PasswordNotSetProfessionalCreateUserErrorError returned by the professionalCreate mutation when no password or samlUserId is provided.
- PhoneNumberPhoneNumber with country code and national number
- ProductAttachmentA product attachment
- ProductOfferAttachmentA product offer attachment
- ProfessionalA professional agent employed by a brand ('Admin', 'Manager' or 'Operator')
- ProfessionalCreateInputContains input data for the professionalCreate mutation to create a professional user
- ProfessionalPermissionPermission granted to a user
- ProfessionalRoleWithPermissionsProfessional Role with its associated user permissions and the role on which it is based
- ProfessionalSetExternalIdInputInput for the `professionalSetExternalId` mutation.
- ProfessionalUpdateInputInput for the `professionalUpdate` mutation. Besides `userId`, all fields are optional, which allows updating only the desired user information.
- Projectnull
- ProjectEdgeAn edge in a connection.
- PseudoIsEmptyProfessionalCreateUserErrorError returned by the professionalCreate mutation when the provided pseudo is empty.
- PseudoIsEmptyProfessionalUpdateUserErrorError returned by the professionalUpdate mutation when the provided pseudo is empty.
- Querynull
- QuickReplyMenuAttachmentA quick reply menu attachment
- ResumeMessageSentSystemAttachmentResume message sent event
- RoutingGroupThanks to the routing groups, you can organise your teams in a flexible way by grouping your agents according to their role (agent, supervisor or administrator), group (i.e: contact centre) or skills (i.e: mobile, photography). A routing group is given a name and a set of segments defining which agents to include in the group.
- RoutingRuleRouting rules determine how to distribute conversations from a set of targeting rules to a set of routing groups, according to a routing mode.
- RoutingRuleEdgeAn edge in a connection.
- RoutingRuleRoutingGroupEdgeAn edge in a connection.
- SAMLUserIdAlreadyUsedErrorThe saml-user-id provided is already used
- SAMLUserIdAlreadyUsedProfessionalCreateUserErrorError returned by the professionalCreate mutation when the provided SAML user id is already used by another user.
- SAMLUserIdIsEmptyErrorMissing value for saml-user-id
- SAMLUserIdIsEmptyProfessionalCreateUserErrorError returned by the professionalCreate mutation when the provided SAML user id is empty.
- SatisfactionConversationnull
- SatisfactionSurveynull
- SatisfactionSurveyResponsenull
- SatisfactionSurveyResponsesPageInfonull
- SearchClosedConversationsFiltersFilters for search closed conversations query
- SkillUsers can be organized by skills in order to automatically direct visitors to the right users. For more information regarding how to use skills, please see the following documentation: https://help.iadvize.com/hc/en-gb/articles/203444283-Use-the-skills.
- SkillCreateInputInput to create a new skill
- SkillEdgeAn edge in a connection.
- SkillUpdateInputInput to update a existing skill
- SupervisorCommentSentSystemAttachmentSupervisor comment sent event
- SurveyMessageSystemAttachmentConversation survey message
- SurveyMultiChoiceQuestionSystemAttachmentConversation survey multiple choices question
- SurveyQuestionSystemAttachmentConversation survey question
- TargetingRuleA targeting rule defines the conditions used to trigger the iAdvize notification.
- ThirdPartyAccountAccount from third party messaging channels
- TimePickerAttachmentA time picker attachment
- TimePickerResponseAttachmentA time picker response attachment
- TransactionA transaction such as a purchase
- TransferredToRoutingRuleSystemAttachmentConversation transferred to routing rule event
- TransferredToUserSystemAttachmentConversation transferred to user event
- Usernull
- UserAvailabilityInputInput for updating the availability status of an operator
- UserCreateInputInput containing the properties of the user to be created
- UserEdgeAn edge in a connection.
- UserErrorRepresents an error in the input of a mutation
- UserGroupUser groups allow information and user exchanges to be compartmentalised in the iAdvize administration. For more information regarding user groups, please see the following documentation: https://help.iadvize.com/hc/en-gb/articles/203280696-Use-the-user-groups.
- UserHasOngoingConversationsUserDeleteErrorThis error is returned by the `userDelete` mutation when the user to be deleted has ongoing conversations, and therefore cannot be deleted. To delete this user, the ongoing conversations must first be transferred to another user, or closed.
- UserNameIsEmptyErrorMissing value for the user-name
- UserProjectEdgeAn edge in a connection.
- UserUpdateInputInput containing the properties of the user to be created
- VideoAttachmentVideo type
- VisitorA visitor is a user who has participated at least once in an iAdvize conversation from his browser, a mobile application or one of the third-party channels supported by iAdvize.
- VisitorConversationCustomDataEntryBooleanA visitor custom data of type Boolean
- VisitorConversationCustomDataEntryFloatA visitor custom data of type Float
- VisitorConversationCustomDataEntryIntA visitor custom data of type Int (32 bits)
- VisitorConversationCustomDataEntryStringA visitor custom data of type String
- VisitorCustomDataBooleanA visitor custom data of type Boolean
- VisitorCustomDataFloatA visitor custom data of type Float
- VisitorCustomDataIntA visitor custom data of type Int (32 bits)
- VisitorCustomDataStringA visitor custom data of type String
- VisitorNotificationSettingsConfirmedSystemAttachmentA message displayed to the visitor to explain that its email has been collected
- VisitorNotificationSettingsRequestedSystemAttachmentA message that requests the visitor to fill its notification settings (usually his email address), so he can be notified when he receives a response
- __DirectiveA Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document. In some cases, you need to provide options to alter GraphQL’s execution behavior in ways field arguments will not suffice, such as conditionally including or skipping a field. Directives provide this by describing additional information to the executor.
- __EnumValueOne possible value for a given Enum. Enum values are unique values, not a placeholder for a string or numeric value. However an Enum value is returned in a JSON response as a string.
- __FieldObject and Interface types are described by a list of Fields, each of which has a name, potentially a list of arguments, and a return type.
- __InputValueArguments provided to Fields or Directives and the input fields of an InputObject are represented as Input Values which describe their type and optionally a default value.
- __SchemaA GraphQL Schema defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, as well as the entry points for query, mutation, and subscription operations.
- __TypeThe fundamental unit of any GraphQL Schema is the type. There are many kinds of types in GraphQL as represented by the `__TypeKind` enum. Depending on the kind of a type, certain fields describe information about that type. Scalar types provide no information beyond a name and description, while Enum types provide their values. Object and Interface types provide the fields they describe. Abstract types, Union and Interface, provide the Object types possible at runtime. List and NonNull types compose other types.