openapi: 3.0.0
servers:
  - url: 'https://api-prd.kpn.com/communication/parley/secure-messenger'
    description: Production server
externalDocs:
  description: Response headers
  url: https://developer.kpn.com/documentation-response-headers
info:
  title: Chat and Messaging - Parley
  version: "v1"
  description: >-
    This API enables a secure communication
    between your agent/bot desktop and the client website/mobile app.


    ## [Source view](https://app.swaggerhub.com/apis/kpn/secure-messenger-parley/)<br/>
    [Documentation view](https://app.swaggerhub.com/apis-docs/kpn/secure-messenger-parley/)
    
    ---
    
    ## [KPN Developer](https://developer.kpn.com/)<br/>
    [Getting Started](https://developer.kpn.com/getting-started)
    
    ---
  termsOfService: 'https://developer.kpn.com/legal'
  contact:
    name: API Support
    email: api_developer@kpn.com
    url: 'https://developer.kpn.com/support'
tags:
  - name: Devices
  - name: Config
  - name: Events
  - name: Messages
paths:
  /messages/{id}:
    get:
      tags:
        - Messages
      summary: Single message
      description: Retrieve a message for a particular user by the message ID.
      operationId: GetMessagesById
      parameters:
        - $ref: '#/components/parameters/api_version'
        - $ref: '#/components/parameters/device_id'
        - $ref: '#/components/parameters/auth_string'
        - $ref: '#/components/parameters/id'
      security:
        - oauth2: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/GetMessageResult/allOf/0/properties/data'
                    required:
                      - data
                  - $ref: '#/components/schemas/GetConfigResult/allOf/1'
              examples:
                success:
                  summary: success
                  value:
                    data:
                      id: 10737
                      time: 1536739259
                      message: hi!
                      image: null
                      typeId: 2
                      agent:
                        id: '1'
                        name: John Doe
                        avatar: 'https://beta.tracebuzz.com//V002//img//avatar.php?i=JD&c=ff0000'
                    notifications: []
                    status: SUCCESS
                    metadata:
                      values:
                        url: messages/10737
                      method: get
                      duration: 0
        '400':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetConfigResult/allOf/1'
              examples:
                authentication_required:
                  $ref: '#/paths/~1messages/get/responses/400/content/application~1json/examples/authentication_required'
                authentication_not_valid:
                  $ref: '#/paths/~1messages/get/responses/400/content/application~1json/examples/authentication_not_valid'
                authentication_expired:
                  $ref: '#/paths/~1messages/get/responses/400/content/application~1json/examples/authentication_expired'
                error:
                  summary: message_not_found
                  description: The message with specified id doesn't exist.
                  value:
                    notifications:
                      - type: error
                        message: message_not_found
                    status: ERROR
                    metadata:
                      values:
                        url: messages/999
                      method: get
                      duration: 0.01
        '401':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetConfigResult/allOf/1'
              examples:
                error:
                  $ref: '#/paths/~1config/get/responses/401/content/application~1json/examples/error'
  /messages:
    get:
      tags:
        - Messages
      summary: Latest messages
      description: |-
        Get the latest 50 messages from and to a particular user.<br /> The order is by time and descending (from new to old)
      operationId: GetMessages
      parameters:
        - $ref: '#/components/parameters/api_version'
        - $ref: '#/components/parameters/device_id'
        - $ref: '#/components/parameters/auth_string'
      security:
        - oauth2: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      data:
                        type: array
                        description: The messages for this user
                        items:
                          $ref: '#/components/schemas/GetMessageResult/allOf/0/properties/data'
                    required:
                      - data
                  - type: object
                    properties:
                      agent:
                        allOf:
                          - type: object
                            description: Object that contains information about the agent that is currently handling the conversation
                            properties:
                              isTyping:
                                type: integer
                                description: 'Timestamp when the agent started typing or 0 if he is not typing '
                            required:
                              - isTyping
                          - $ref: '#/components/schemas/Message/properties/agent'
                    required:
                      - agent
                  - type: object
                    properties:
                      paging:
                        type: object
                        description: A helper to let you determine which paging endpoint to use to 'walk through' all the messages of this user
                        properties:
                          before:
                            type: string
                            description: 'The endpoint you need to call to get the previous 50 messages. '
                          after:
                            type: string
                            description: The endpoint to call if you want to poll for newer messages since this call
                        required:
                          - before
                          - after
                    required:
                      - paging
                  - $ref: '#/components/schemas/GetConfigResult/allOf/1'
              examples:
                success:
                  summary: messages_returned
                  value:
                    data:
                      - id: 10737
                        time: 1536739259
                        message: hi!
                        image: null
                        typeId: 2
                        agent:
                          id: '2'
                          name: Gerben
                          avatar: 'https://beta.tracebuzz.com/images/avatars/1912991618/6033.jpg'
                      - id: 10736
                        time: 1536739157
                        message: 'Hello, i have a question'
                        image: null
                        typeId: 1
                        agent: null
                    agent:
                      id: '2'
                      name: Gerben
                      avatar: 'https://beta.tracebuzz.com/images/avatars/1912991618/6033.jpg'
                      isTyping: 0
                    paging:
                      before: ''
                      after: '/messages/after:10737'
                    notifications: []
                    status: SUCCESS
                    metadata:
                      values:
                        url: messages
                      method: get
                      duration: 0.01
        '400':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetConfigResult/allOf/1'
              examples:
                authentication_required:
                  summary: authentication_required
                  value:
                    notifications:
                      - type: error
                        message: authentication_required
                    status: ERROR
                    metadata:
                      values:
                        url: devices
                      method: post
                      duration: 0.01
                authentication_not_valid:
                  summary: authentication_not_valid
                  value:
                    notifications:
                      - type: error
                        message: authentication_not_valid
                    status: ERROR
                    metadata:
                      values:
                        url: devices
                      method: post
                      duration: 0.01
                authentication_expired:
                  summary: authentication_expired
                  value:
                    notifications:
                      - type: error
                        message: authentication_expired
                    status: ERROR
                    metadata:
                      values:
                        url: devices
                      method: post
                      duration: 0.01
        '401':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetConfigResult/allOf/1'
              examples:
                error:
                  $ref: '#/paths/~1config/get/responses/401/content/application~1json/examples/error'
    post:
      tags:
        - Messages
      summary: Send message
      description: Post a message to the API where the 'sender' is a particular user.<br><br> **Important**<br> You can choose to send a text message or an message with an image. For the textual message you send a 'regular' POST request with the parameters described in 'Query parameters'. To send an image in a message you need to send a POST as multipart/form-data with the attributes from 'Request Body schema'
      operationId: PostMessages
      parameters:
        - $ref: '#/components/parameters/api_version'
        - $ref: '#/components/parameters/device_id'
        - $ref: '#/components/parameters/auth_string'
        - name: message
          required: true
          in: query
          schema:
            type: string
          description: The message from the user to the accountIt is required to set either message or image
        - name: typeId
          required: false
          in: query
          schema:
            type: integer
            enum:
              - 1
              - 4
          description: >-
            The type of the message. Can be one of the following: 
              - Message from the user `default`
              - Automated/system message from the user
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                image:
                  type: string
                  format: binary
                  description: >-
                    The image contents. The image should have one of the following mime-types:
                      - image/jpeg
                      - image/png
                      - image/gif
                typeId:
                  type: integer
                  enum:
                    - 1
                    - 4
                  description: |-
                    The type of the message. Can be one of the following:
                      - Message from the user <code>default</code>
                      - Automated/system message from the user
            encoding:
              image:
                contentType: 'image/jpeg, image/png, image/gif'
      security:
        - oauth2: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      data:
                        type: object
                        description: The success data
                        properties:
                          messageId:
                            type: string
                            format: integer
                            description: The id of the message we just created
                  - $ref: '#/components/schemas/GetConfigResult/allOf/1'
                required:
                  - data
              examples:
                success:
                  summary: post_message
                  value:
                    data:
                      messageId: '10743'
                    notifications: []
                    status: SUCCESS
                    metadata:
                      values:
                        url: messages
                        message: test
                      method: post
                      duration: 0.01
        '400':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetConfigResult/allOf/1'
              examples:
                authentication_required:
                  $ref: '#/paths/~1messages/get/responses/400/content/application~1json/examples/authentication_required'
                authentication_not_valid:
                  $ref: '#/paths/~1messages/get/responses/400/content/application~1json/examples/authentication_not_valid'
                authentication_expired:
                  $ref: '#/paths/~1messages/get/responses/400/content/application~1json/examples/authentication_expired'
                missing_message_or_image:
                  summary: missing_message_or_image
                  value:
                    notifications:
                      - type: error
                        message: missing_message_or_image
                    status: ERROR
                    metadata:
                      values:
                        url: messages
                      method: post
                      duration: 0.01
                image_too_large:
                  summary: image_too_large
                  value:
                    notifications:
                      - type: error
                        message: image_too_large
                    status: ERROR
                    metadata:
                      values:
                        url: messages
                      method: post
                      duration: 0.01
                image_not_uploaded:
                  summary: image_not_uploaded
                  value:
                    notifications:
                      - type: error
                        message: image_not_uploaded
                    status: ERROR
                    metadata:
                      values:
                        url: messages
                      method: post
                      duration: 0.01
                invalid_image:
                  summary: invalid_image
                  value:
                    notifications:
                      - type: error
                        message: invalid_image
                    status: ERROR
                    metadata:
                      values:
                        url: messages
                      method: post
                      duration: 0.01
                could_not_save_message:
                  summary: could_not_save_message
                  value:
                    notifications:
                      - type: error
                        message: could_not_save_message
                    status: ERROR
                    metadata:
                      values:
                        url: messages
                      method: post
                      duration: 0.01
                invalid_message_type:
                  summary: invalid_message_type
                  description: >-
                    The supplied message type is not one of 
                    1. User message
                    4. User system message
                  value:
                    notifications:
                      - type: error
                        message: invalid_message_type
                    status: ERROR
                    metadata:
                      values:
                        url: messages
                      method: post
                      duration: 0.01
        '401':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetConfigResult/allOf/1'
              examples:
                error:
                  $ref: '#/paths/~1config/get/responses/401/content/application~1json/examples/error'
  /messages/{paging}:{id}:
    get:
      tags:
        - Messages
      summary: Get older/newer messages
      description: 'Retrieve messages for a particular user by a paginator, defined as ''before:messageID'' or ''after:messagedID''.'
      operationId: GetMessagesByPaging
      parameters:
        - name: paging
          in: path
          required: true
          description: 'The paging endpoint is the easiest when you follow the direction in the `paging` parameter you get returned on each call to get a list of messages (latest & paging). This parameter will describe exactly what you need to use this endpoint.<br> <br> But you can create the paging parameter yourself as well, you can use `before` or `after` to get message before or after a specific message you have retrieved before.'
          schema:
            type: string
            enum:
              - before
              - after
        - $ref: '#/components/parameters/id'
        - $ref: '#/components/parameters/api_version'
        - $ref: '#/components/parameters/device_id'
        - $ref: '#/components/parameters/auth_string'
      security:
        - oauth2: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/paths/~1messages/get/responses/200/content/application~1json/schema'
              examples:
                success:
                  summary: messages_returned
                  value:
                    data:
                      - id: 10737
                        time: 1536739259
                        message: hi!
                        image: null
                        typeId: 2
                        agent:
                          id: '2'
                          name: Gerben
                          avatar: 'https://beta.tracebuzz.com/images/avatars/1912991618/6033.jpg'
                    agent:
                      id: '2'
                      name: Gerben
                      avatar: 'https://beta.tracebuzz.com/images/avatars/1912991618/6033.jpg'
                      isTyping: 0
                    paging:
                      before: '/messages/before:10737'
                      after: '/messages/after:10737'
                    notifications: []
                    status: SUCCESS
                    metadata:
                      values:
                        url: 'messages/after:10736'
                      method: get
                      duration: 0.01
        '400':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetConfigResult/allOf/1'
              examples:
                authentication_required:
                  $ref: '#/paths/~1messages/get/responses/400/content/application~1json/examples/authentication_required'
                authentication_not_valid:
                  $ref: '#/paths/~1messages/get/responses/400/content/application~1json/examples/authentication_not_valid'
                authentication_expired:
                  $ref: '#/paths/~1messages/get/responses/400/content/application~1json/examples/authentication_expired'
        '401':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetConfigResult/allOf/1'
              examples:
                error:
                  $ref: '#/paths/~1config/get/responses/401/content/application~1json/examples/error'
  /services/event/startTyping:
    post:
      tags:
        - Events
      summary: Send StartTyping event
      description: 'Fires the StartTyping event and pushes data to the service '
      operationId: PostEventStartTyping
      security:
        - oauth2: []
      parameters:
        - $ref: '#/components/parameters/api_version'
        - $ref: '#/components/parameters/auth_string'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/paths/~1services~1event~1stopTyping/post/responses/200/content/application~1json/schema'
              examples:
                success:
                  summary: success
                  value:
                    data: event startTyping executed
                    notifications: []
                    status: SUCCESS
                    metadata:
                      values:
                        url: services/event/startTyping
                      method: post
                      duration: 0.01
        '400':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetConfigResult/allOf/1'
              examples:
                error:
                  summary: Something went wrong with the event
                  value:
                    notifications:
                      - type: error
                        message: Something went wrong with the event
                    status: ERROR
                    metadata:
                      values:
                        url: services/event/startTyping
                      method: post
                      duration: 0.01
                error2:
                  summary: Could not reach the service
                  value:
                    notifications:
                      - type: error
                        message: Could not reach the service
                    status: ERROR
                    metadata:
                      values:
                        url: services/event/startTyping
                      method: post
                      duration: 0.01
        '401':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetConfigResult/allOf/1'
              examples:
                error:
                  $ref: '#/paths/~1config/get/responses/401/content/application~1json/examples/error'
  /services/event/stopTyping:
    post:
      tags:
        - Events
      summary: Send StopTyping event
      description: 'Fires the StopTyping event and pushes data to the service '
      operationId: PostEventStopTyping
      parameters:
        - $ref: '#/components/parameters/api_version'
        - $ref: '#/components/parameters/auth_string'
      security:
        - oauth2: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      data:
                        type: string
                        description: A message indicating that the event has been executed
                    required:
                      - data
                  - $ref: '#/components/schemas/GetConfigResult/allOf/1'
              examples:
                success:
                  summary: success
                  value:
                    data: event stopTyping executed
                    notifications: []
                    status: SUCCESS
                    metadata:
                      values:
                        url: services/event/stopTyping
                      method: post
                      duration: 0.01
        '400':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetConfigResult/allOf/1'
              examples:
                error:
                  summary: Something went wrong with the event
                  value:
                    notifications:
                      - type: error
                        message: Something went wrong with the event
                    status: ERROR
                    metadata:
                      values:
                        url: services/event/stopTyping
                      method: post
                      duration: 0.01
                error2:
                  summary: Could not reach the service
                  value:
                    notifications:
                      - type: error
                        message: Could not reach the service
                    status: ERROR
                    metadata:
                      values:
                        url: services/event/stopTyping
                      method: post
                      duration: 0.01
        '401':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetConfigResult/allOf/1'
              examples:
                error:
                  $ref: '#/paths/~1config/get/responses/401/content/application~1json/examples/error'
  /devices:
    post:
      tags:
        - Devices
      summary: Subscribe device
      description: 'You need to subscribe the device before you can send and get messages.<br /> When you do not subscribe, we can''t tell who you are. It''s that important.<br /> When you subscribe you will also want to setup the pushToken and pushType of your device to receive updates when a new event or message is available for this device.<br /> To make the different push types work for your application, you will need to contact <a href="http://parley.nu/contact" target="_blank">Parley</a> to configure one or multiple pushTypes.'
      operationId: PostDevices
      parameters:
        - $ref: '#/components/parameters/api_version'
        - $ref: '#/components/parameters/device_id'
        - $ref: '#/components/parameters/auth_string'
        - name: pushToken
          in: query
          schema:
            type: string
          description: 'A push token for the device. This is used to send the device a push message when the account respond. Must be unique, if they are re-used they will be deleted from previous device(s).'
        - name: pushType
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 5
          description: |-
            The type of push token. <ol>
              - Google Cloud Messaging
              - Apple Push Notification Service
              - Firebase Cloud Messaging
              - Custom webhook
              - Custom webhook behind OAuth
            </ol>
        - name: userAdditionalInformation
          in: query
          schema:
            type: string
          description: 'Addition information for the user. You can add anything you want, should be in a key value combination and key must be a string. It&#39;s logical to send the name of the authenticated user.                                                          For privacy reasons we want as little information as possible for you to work with. And remember that we can&#39;t verify that wat is sent here is really about the user.'
        - name: type
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 4
          description: |-
            The type of device. <ol>
              - Android
              - iOS
              - Web
              - Generic (custom build)
            </ol>
        - name: version
          in: query
          schema:
            type: string
            pattern: '([0-9]{1,2}.[0-9]{1,2}.[0-9]{1,2}|[0-9]{6})'
            minLength: 5
            maxLength: 8
          description: The version number of the client application. Format &quot;1.2.3&quot; or &quot;01.02.03&quot; or &quot;010203&quot; but NOT &quot;123&quot;
      security:
        - oauth2: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  allOf:
                    - type: object
                      properties:
                        data:
                          type: object
                      required:
                        - data
                    - $ref: '#/components/schemas/GetConfigResult/allOf/1'
              examples:
                success:
                  summary: success
                  value:
                    data: {}
                    notifications:
                      - type: success
                        message: device_successfully_subscribed
                    status: SUCCESS
                    metadata:
                      values:
                        url: devices
                      method: post
                      duration: 0.01
                warning:
                  summary: warning
                  value:
                    data: {}
                    notifications:
                      - type: warning
                        message: malformed_userAdditionalInformation
                      - type: success
                        message: device_successfully_subscribed
                    status: SUCCESS
                    metadata:
                      values:
                        url: devices
                        userAdditionalInformation: 'some additional information: a = b, foo = bar'
                      method: post
                      duration: 0.01
        '400':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetConfigResult/allOf/1'
              examples:
                authentication_required:
                  $ref: '#/paths/~1messages/get/responses/400/content/application~1json/examples/authentication_required'
                authentication_not_valid:
                  $ref: '#/paths/~1messages/get/responses/400/content/application~1json/examples/authentication_not_valid'
                authentication_expired:
                  $ref: '#/paths/~1messages/get/responses/400/content/application~1json/examples/authentication_expired'
                error:
                  summary: could_not_subscribe_device
                  value:
                    notifications:
                      - type: error
                        message: could_not_subscribe_device
                    status: ERROR
                    metadata:
                      values:
                        url: devices
                      method: post
                      duration: 0.01
                invalid_x:
                  summary: invalid_x
                  value:
                    notifications:
                      - type: error
                        message: invalid_version_format
                    status: ERROR
                    metadata:
                      values:
                        url: devices
                        version: '123123213'
                      method: post
                      duration: 0.01
                could_not_update_x:
                  summary: could_not_update_x
                  value:
                    notifications:
                      - type: error
                        message: could_not_update_pushToken
                    status: ERROR
                    metadata:
                      values:
                        url: devices
                        puhsToken: AAAAAAAAAAAAA2342341412
                      method: post
                      duration: 0.01
        '401':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetConfigResult/allOf/1'
              examples:
                error:
                  $ref: '#/paths/~1config/get/responses/401/content/application~1json/examples/error'
  /config:
    get:
      tags:
        - Config
      summary: Get Config
      description: Request the configuration for the identified account.<br /> This contains settings and display settings of the account.<br /> All colors are RGB colors saved in hexadecimals.
      operationId: GetConfig
      security:
        - oauth2: []
      parameters:
        - $ref: '#/components/parameters/api_version'
        - $ref: '#/components/parameters/device_id'
        - $ref: '#/components/parameters/auth_string'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/GetConfigResult/allOf/0/properties/data'
                    required:
                      - data
                  - $ref: '#/components/schemas/GetConfigResult/allOf/1'
              examples:
                success:
                  summary: success
                  value:
                    data:
                      name: string
                      telephone: string
                      font: 0
                      allowImage: true
                      backgroundColor: string
                      backgroundImage: string
                      iOSStatusBarTextColor: 0
                      navBackgroundColor: string
                      navTextColor: string
                      navHideCloseButton: string
                      dateColor: string
                      dateBorder: true
                      iOSInputContainerBackgroundColor: string
                      inputFieldBackgroundColor: string
                      inputFieldTextColor: string
                      inputFieldPlaceholderColor: string
                      inputBackgroundColor: string
                      inputTextColor: string
                      balloonStyle: 0
                      userBackgroundColor: string
                      userTextColor: string
                      userTextLinkColor: string
                      userTimeColor: string
                      userSentColor: string
                      accountBackgroundColor: string
                      accountTextColor: string
                      accountTextLinkColor: string
                      accountTimeColor: string
                      infoTextBackgroundColor: string
                      infoTextBorder: 0
                      infoTextColor: string
                      infoText: string
                      infoText2: string
                      genericPushMessage: string
                    notifications: []
                    status: SUCCESS
                    metadata:
                      values:
                        url: config
                      method: get
                      duration: 0.01
        '401':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetConfigResult/allOf/1'
              examples:
                error:
                  summary: invalid api key
                  value:
                    notifications:
                      - type: error
                        message: api_key_not_valid
                    status: ERROR
                    metadata:
                      values:
                        url: string
                      method: string
                      duration: 0.01
components:
  schemas:
    BaseResult:
      description: Object that will always be returned with every call.
      properties:
        notifications:
          type: array
          description: 'The error or success notifications returned by the api call '
          items:
            type: object
            properties:
              type:
                type: string
                enum:
                  - success
                  - warning
                  - error
                description: The type of notifications on a success call
              message:
                type: string
                description: The description of what went right or what caused the notification
            required:
              - type
              - message
        status:
          type: string
          enum:
            - SUCCESS
            - ERROR
          description: Indicates if a call succeeded or failed
        metadata:
          type: object
          description: Metadata about the API call as we received it
          properties:
            values:
              type: object
              description: 'The parameters that you specified in this api call '
            method:
              type: string
              description: 'The HTTP method of this call '
            duration:
              type: number
              format: float
              description: 'The duration of this call on our servers. '
          required:
            - values
            - method
            - duration
      required:
        - notifications
        - status
        - metadata
    Agent:
      type: object
      description: Object that contains information about the agent that has send this message. Is only filled when the message type is 2 or 5.
      properties:
        avatar:
          type: string
          description: 'The url to the avatar the Agent uses '
        id:
          type: integer
          description: 'The id of the Agent '
        name:
          type: string
          description: 'The name of the Agent '
      required:
        - avatar
        - id
        - isTyping
        - name
    Config:
      properties:
        name:
          type: string
          description: 'The name of the authenticated application '
        telephone:
          type: string
          description: 'The telephone number of the helpdesk '
        font:
          type: integer
          minimum: 1
          maximum: 5
          description: |-
            The font for all the text <ol>
              - San serif
              - Serif
              - Monospace
              - Open Sans
              - PT Sans
            </ol>
        allowImage:
          type: boolean
          description: 'If it is possible to send images to the api '
        backgroundColor:
          type: string
          format: hexadecimal
          minLength: 6
          maxLength: 6
          description: 'The main background color, behind the messages from the user and account. This (and all other colors) is defined as RGB , e.g. FF0000 for bright red'''
        backgroundImage:
          type: string
          description: 'The image used as main background. This overrules the main background color but the color should be used in case this image doesn&#39;t load.'
        iOSStatusBarTextColor:
          type: integer
          minimum: 0
          maximum: 1
          description: |-
            The text color for the status bar in iOs <ol start='0'>
              - White
              - Black
            </ol>
        navBackgroundColor:
          type: string
          format: hexadecimal
          minLength: 6
          maxLength: 6
          description: 'The background color of the main navigation. '
        navTextColor:
          type: string
          format: hexadecimal
          minLength: 6
          maxLength: 6
          description: 'The color of the text (and images) used in the main navigation '
        navHideCloseButton:
          type: boolean
          description: 'If the Close / back button must be hidden '
        dateColor:
          type: string
          format: hexadecimal
          minLength: 6
          maxLength: 6
          description: The color of the date text and border that separates the messages send on different dates.
        dateBorder:
          type: boolean
          description: This indicates whether or not to show a border around the date element in the chat.
        iOSInputContainerBackgroundColor:
          type: string
          format: hexadecimal
          minLength: 6
          maxLength: 6
          description: The color of the bottom bar on iOS which contains the text field and the send &amp; picture buttons
        inputFieldBackgroundColor:
          type: string
          format: hexadecimal
          minLength: 6
          maxLength: 6
          description: The background color of the element containing the message that the user is typing/sending.
        inputFieldTextColor:
          type: string
          format: hexadecimal
          minLength: 6
          maxLength: 6
          description: 'The color of the text that the user is typing '
        inputFieldPlaceholderColor:
          type: string
          format: hexadecimal
          minLength: 6
          maxLength: 6
          description: 'When there is no text in the input field we show a placeholder (type your message..), this is the color of that placeholder. Usually it is a bit of a lighter than the regular text color.'
        inputBackgroundColor:
          type: string
          format: hexadecimal
          minLength: 6
          maxLength: 6
          description: 'The background color of the button that sends the typed message, or the color of that button when the button only has 1 color'
        inputTextColor:
          type: string
          format: hexadecimal
          minLength: 6
          maxLength: 6
          description: 'The front color of the send button this is usualy an icon on top of the inputBackgroundColor and might nog be used when the send button doesn&#39;t have two color tones.'
        balloonStyle:
          type: integer
          minimum: 1
          maximum: 2
          description: This is a choice between the different styles of the balloons containing user or account messages.
        userBackgroundColor:
          type: string
          format: hexadecimal
          minLength: 6
          maxLength: 6
          description: The background color of the balloon containing a message that the user sends
        userTextColor:
          type: string
          format: hexadecimal
          minLength: 6
          maxLength: 6
          description: 'The color of the message that the user sends '
        userTextLinkColor:
          type: string
          format: hexadecimal
          minLength: 6
          maxLength: 6
          description: 'When the user sends a link, this is the color it will appear in. '
        userTimeColor:
          type: string
          format: hexadecimal
          minLength: 6
          maxLength: 6
          description: 'The color of the time shown in the balloon of a user message '
        userSentColor:
          type: string
          format: hexadecimal
          minLength: 6
          maxLength: 6
          description: The color of the element that shows if the message is successfully sent (or not)
        accountBackgroundColor:
          type: string
          format: hexadecimal
          minLength: 6
          maxLength: 6
          description: The background color of the balloon containing a message that the account sends back
        accountTextColor:
          type: string
          format: hexadecimal
          minLength: 6
          maxLength: 6
          description: 'The color of the message that the account sends back '
        accountTextLinkColor:
          type: string
          format: hexadecimal
          minLength: 6
          maxLength: 6
          description: A linked that is shared by the account will highlight in this color to show you can click on it.
        accountTimeColor:
          type: string
          format: hexadecimal
          minLength: 6
          maxLength: 6
          description: The color of the time shown in the balloon of a message from the account
        infoTextBackgroundColor:
          type: string
          format: hexadecimal
          minLength: 6
          maxLength: 6
          description: 'The background color of the info messages. This could contain an empty string, to indicate that the background should be transparant.'
        infoTextBorder:
          type: integer
          minimum: 0
          maximum: 2
          description: |-
            This indicates the type of border to show around the infoText element. <ol start='0'>
              - No border
              - Top and bottom border
              - All borders
            </ol>
        infoTextColor:
          type: string
          format: hexadecimal
          minLength: 6
          maxLength: 6
          description: The color of the info messages that are shown before or between message balloons
        infoText:
          type: string
          description: The welcome text that is shown when a user opens the messages view for the first time. This message wil always be on top of all the messages send between a user and account.
        infoText2:
          type: string
          description: 'The welcome text that is shown when a user opens the messages view for the first time. But the user hasn&#39;t granted push notification rights. It displays instead of infoText'
        genericPushMessage:
          type: string
          description: The generic text that should be used when showing a push notification message
      required:
        - name
        - telephone
        - font
        - allowImage
        - backgroundColor
        - backgroundImage
        - iOSStatusBarTextColor
        - navBackgroundColor
        - navTextColor
        - navHideCloseButton
        - dateColor
        - dateBorder
        - iOSInputContainerBackgroundColor
        - inputFieldBackgroundColor
        - inputFieldTextColor
        - inputFieldPlaceholderColor
        - inputBackgroundColor
        - inputTextColor
        - balloonStyle
        - userBackgroundColor
        - userTextColor
        - userTextLinkColor
        - userTimeColor
        - userSentColor
        - accountBackgroundColor
        - accountTextColor
        - accountTextLinkColor
        - accountTimeColor
        - infoTextBackgroundColor
        - infoTextBorder
        - infoTextColor
        - infoText
        - infoText2
        - genericPushMessage
    GetConfigResult:
      allOf:
        - type: object
          properties:
            data:
              properties:
                name:
                  type: string
                  description: 'The name of the authenticated application '
                telephone:
                  type: string
                  description: 'The telephone number of the helpdesk '
                font:
                  type: integer
                  minimum: 1
                  maximum: 5
                  description: |-
                    The font for all the text <ol>
                      - San serif
                      - Serif
                      - Monospace
                      - Open Sans
                      - PT Sans
                    </ol>
                allowImage:
                  type: boolean
                  description: 'If it is possible to send images to the api '
                backgroundColor:
                  type: string
                  format: hexadecimal
                  minLength: 6
                  maxLength: 6
                  description: 'The main background color, behind the messages from the user and account. This (and all other colors) is defined as RGB , e.g. FF0000 for bright red'''
                backgroundImage:
                  type: string
                  description: 'The image used as main background. This overrules the main background color but the color should be used in case this image doesn&#39;t load.'
                iOSStatusBarTextColor:
                  type: integer
                  minimum: 0
                  maximum: 1
                  description: |-
                    The text color for the status bar in iOs <ol start='0'>
                      - White
                      - Black
                    </ol>
                navBackgroundColor:
                  type: string
                  format: hexadecimal
                  minLength: 6
                  maxLength: 6
                  description: 'The background color of the main navigation. '
                navTextColor:
                  type: string
                  format: hexadecimal
                  minLength: 6
                  maxLength: 6
                  description: 'The color of the text (and images) used in the main navigation '
                navHideCloseButton:
                  type: boolean
                  description: 'If the Close / back button must be hidden '
                dateColor:
                  type: string
                  format: hexadecimal
                  minLength: 6
                  maxLength: 6
                  description: The color of the date text and border that separates the messages send on different dates.
                dateBorder:
                  type: boolean
                  description: This indicates whether or not to show a border around the date element in the chat.
                iOSInputContainerBackgroundColor:
                  type: string
                  format: hexadecimal
                  minLength: 6
                  maxLength: 6
                  description: The color of the bottom bar on iOS which contains the text field and the send &amp; picture buttons
                inputFieldBackgroundColor:
                  type: string
                  format: hexadecimal
                  minLength: 6
                  maxLength: 6
                  description: The background color of the element containing the message that the user is typing/sending.
                inputFieldTextColor:
                  type: string
                  format: hexadecimal
                  minLength: 6
                  maxLength: 6
                  description: 'The color of the text that the user is typing '
                inputFieldPlaceholderColor:
                  type: string
                  format: hexadecimal
                  minLength: 6
                  maxLength: 6
                  description: 'When there is no text in the input field we show a placeholder (type your message..), this is the color of that placeholder. Usually it is a bit of a lighter than the regular text color.'
                inputBackgroundColor:
                  type: string
                  format: hexadecimal
                  minLength: 6
                  maxLength: 6
                  description: 'The background color of the button that sends the typed message, or the color of that button when the button only has 1 color'
                inputTextColor:
                  type: string
                  format: hexadecimal
                  minLength: 6
                  maxLength: 6
                  description: 'The front color of the send button this is usualy an icon on top of the inputBackgroundColor and might nog be used when the send button doesn&#39;t have two color tones.'
                balloonStyle:
                  type: integer
                  minimum: 1
                  maximum: 2
                  description: This is a choice between the different styles of the balloons containing user or account messages.
                userBackgroundColor:
                  type: string
                  format: hexadecimal
                  minLength: 6
                  maxLength: 6
                  description: The background color of the balloon containing a message that the user sends
                userTextColor:
                  type: string
                  format: hexadecimal
                  minLength: 6
                  maxLength: 6
                  description: 'The color of the message that the user sends '
                userTextLinkColor:
                  type: string
                  format: hexadecimal
                  minLength: 6
                  maxLength: 6
                  description: 'When the user sends a link, this is the color it will appear in. '
                userTimeColor:
                  type: string
                  format: hexadecimal
                  minLength: 6
                  maxLength: 6
                  description: 'The color of the time shown in the balloon of a user message '
                userSentColor:
                  type: string
                  format: hexadecimal
                  minLength: 6
                  maxLength: 6
                  description: The color of the element that shows if the message is successfully sent (or not)
                accountBackgroundColor:
                  type: string
                  format: hexadecimal
                  minLength: 6
                  maxLength: 6
                  description: The background color of the balloon containing a message that the account sends back
                accountTextColor:
                  type: string
                  format: hexadecimal
                  minLength: 6
                  maxLength: 6
                  description: 'The color of the message that the account sends back '
                accountTextLinkColor:
                  type: string
                  format: hexadecimal
                  minLength: 6
                  maxLength: 6
                  description: A linked that is shared by the account will highlight in this color to show you can click on it.
                accountTimeColor:
                  type: string
                  format: hexadecimal
                  minLength: 6
                  maxLength: 6
                  description: The color of the time shown in the balloon of a message from the account
                infoTextBackgroundColor:
                  type: string
                  format: hexadecimal
                  minLength: 6
                  maxLength: 6
                  description: 'The background color of the info messages. This could contain an empty string, to indicate that the background should be transparant.'
                infoTextBorder:
                  type: integer
                  minimum: 0
                  maximum: 2
                  description: |-
                    This indicates the type of border to show around the infoText element. <ol start='0'>
                      - No border
                      - Top and bottom border
                      - All borders
                    </ol>
                infoTextColor:
                  type: string
                  format: hexadecimal
                  minLength: 6
                  maxLength: 6
                  description: The color of the info messages that are shown before or between message balloons
                infoText:
                  type: string
                  description: The welcome text that is shown when a user opens the messages view for the first time. This message wil always be on top of all the messages send between a user and account.
                infoText2:
                  type: string
                  description: 'The welcome text that is shown when a user opens the messages view for the first time. But the user hasn&#39;t granted push notification rights. It displays instead of infoText'
                genericPushMessage:
                  type: string
                  description: The generic text that should be used when showing a push notification message
              required:
                - name
                - telephone
                - font
                - allowImage
                - backgroundColor
                - backgroundImage
                - iOSStatusBarTextColor
                - navBackgroundColor
                - navTextColor
                - navHideCloseButton
                - dateColor
                - dateBorder
                - iOSInputContainerBackgroundColor
                - inputFieldBackgroundColor
                - inputFieldTextColor
                - inputFieldPlaceholderColor
                - inputBackgroundColor
                - inputTextColor
                - balloonStyle
                - userBackgroundColor
                - userTextColor
                - userTextLinkColor
                - userTimeColor
                - userSentColor
                - accountBackgroundColor
                - accountTextColor
                - accountTextLinkColor
                - accountTimeColor
                - infoTextBackgroundColor
                - infoTextBorder
                - infoTextColor
                - infoText
                - infoText2
                - genericPushMessage
          required:
            - data
        - description: Object that will always be returned with every call.
          properties:
            notifications:
              type: array
              description: 'The error or success notifications returned by the api call '
              items:
                type: object
                properties:
                  type:
                    type: string
                    enum:
                      - success
                      - warning
                      - error
                    description: The type of notifications on a success call
                  message:
                    type: string
                    description: The description of what went right or what caused the notification
                required:
                  - type
                  - message
            status:
              type: string
              enum:
                - SUCCESS
                - ERROR
              description: Indicates if a call succeeded or failed
            metadata:
              type: object
              description: Metadata about the API call as we received it
              properties:
                values:
                  type: object
                  description: 'The parameters that you specified in this api call '
                method:
                  type: string
                  description: 'The HTTP method of this call '
                duration:
                  type: number
                  format: float
                  description: 'The duration of this call on our servers. '
              required:
                - values
                - method
                - duration
          required:
            - notifications
            - status
            - metadata
    GetMessageResult:
      allOf:
        - type: object
          properties:
            data:
              description: Object that contains all the information about a specific message
              properties:
                id:
                  type: integer
                  description: The id of the specific message.
                time:
                  type: integer
                  format: Unix Timestamp
                  description: A Unix Timestamp of the time this message was created
                message:
                  type: string
                  description: The message that is send
                image:
                  type: string
                  description: |-
                    The url of the image. When an image is send message will always be empty.The image can have one of the following mime-types: <ul>
                      - image/jpeg
                      - image/png
                      - image/gif
                    </ul> To retrieve an image you need to provide the same headers as you used to retrieve this message.
                typeId:
                  type: integer
                  minimum: 1
                  maximum: 5
                  description: |-
                    The type of the specific message. <ol>
                      - Message from the user
                      - Message from the account
                      - Info message
                      - Automated/system message from the user
                      - Automated/system message from the account
                    </ol>
                agent:
                  $ref: '#/components/schemas/Message/properties/agent'
              required:
                - id
                - time
                - typeId
                - message
          required:
            - data
        - $ref: '#/components/schemas/GetConfigResult/allOf/1'
    GetMessagesResult:
      allOf:
        - type: object
          properties:
            data:
              type: array
              description: The messages for this user
              items:
                $ref: '#/components/schemas/GetMessageResult/allOf/0/properties/data'
          required:
            - data
        - type: object
          properties:
            agent:
              allOf:
                - type: object
                  description: Object that contains information about the agent that is currently handling the conversation
                  properties:
                    isTyping:
                      type: integer
                      description: 'Timestamp when the agent started typing or 0 if he is not typing '
                  required:
                    - isTyping
                - $ref: '#/components/schemas/Message/properties/agent'
          required:
            - agent
        - type: object
          properties:
            paging:
              type: object
              description: A helper to let you determine which paging endpoint to use to 'walk through' all the messages of this user
              properties:
                before:
                  type: string
                  description: 'The endpoint you need to call to get the previous 50 messages. '
                after:
                  type: string
                  description: The endpoint to call if you want to poll for newer messages since this call
              required:
                - before
                - after
          required:
            - paging
        - $ref: '#/components/schemas/GetConfigResult/allOf/1'
    Message:
      description: Object that contains all the information about a specific message
      properties:
        id:
          type: integer
          description: The id of the specific message.
        time:
          type: integer
          format: Unix Timestamp
          description: A Unix Timestamp of the time this message was created
        message:
          type: string
          description: The message that is send
        image:
          type: string
          description: |-
            The url of the image. When an image is send message will always be empty.The image can have one of the following mime-types: <ul>
              - image/jpeg
              - image/png
              - image/gif
            </ul> To retrieve an image you need to provide the same headers as you used to retrieve this message.
        typeId:
          type: integer
          minimum: 1
          maximum: 5
          description: |-
            The type of the specific message. <ol>
              - Message from the user
              - Message from the account
              - Info message
              - Automated/system message from the user
              - Automated/system message from the account
            </ol>
        agent:
          type: object
          description: Object that contains information about the agent that has send this message. Is only filled when the message type is 2 or 5.
          properties:
            avatar:
              type: string
              description: 'The url to the avatar the Agent uses '
            id:
              type: integer
              description: 'The id of the Agent '
            name:
              type: string
              description: 'The name of the Agent '
          required:
            - avatar
            - id
            - isTyping
            - name
      required:
        - id
        - time
        - typeId
        - message
    PostDevicesResult:
      allOf:
        - type: object
          properties:
            data:
              type: object
          required:
            - data
        - $ref: '#/components/schemas/GetConfigResult/allOf/1'
    PostMessagesResult:
      allOf:
        - type: object
          properties:
            data:
              type: object
              description: The success data
              properties:
                messageId:
                  type: string
                  format: integer
                  description: The id of the message we just created
        - $ref: '#/components/schemas/GetConfigResult/allOf/1'
      required:
        - data
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://api-prd.kpn.com/oauth/client_credential/accesstoken?grant_type=client_credentials
          scopes : {}
  parameters:
    api_version:
      in: header
      name: api-version
      schema:
        type: string
      description: >-
          API Version. If no version is provided it defaults to latest version.
      required: false
    device_id:
      in: header
      name: uniqueAppDeviceId
      schema:
        type: string
      description: >-
        You can use/generate your own uniqueAppDeviceId. It should be at least 10 characters long.
      required: true
    auth_string:
      in: header
      name: authString
      schema:
        type: string
      description: >-
        The authentication of an user in your application. This string needs to be generated in a trusted environment (not inside the app). Documentation about how to generate this string can be found
        [here](https://gist.github.com/Gerben-T/36c71faf1879022ac5fa65ccd77b8f75)
      required: false
    id:
      name: id
      in: path
      required: true
      description: 'The identifier of the message you want '
      schema:
        type: integer