/icws/{sessionId}/directories/speed-dial/{speedDialDirectoryId}/links

POST

/icws/{sessionId}/directories/speed-dial/{speedDialDirectoryId}/links

Creates a link from a speed dial directory to a contact entry in the current directory. The speed dial directory is a directory containing links to other directories' contact entries.

Feature Version
directories 10

Request

Parameters
Type
Name
Comments
Header
ININ-ICWS-CSRF-Token

Required

The ININ session token necessary for all calls that require a security or user context.

    Header
    Cookie

    Required

    The session cookie. With the exception of the connection request, all requests must provide a session cookie.

      Template
      sessionId

      Required

      The ININ session ID necessary for all calls that require a security or user context.

        Template
        speedDialDirectoryId

        Required

        The speed dial directory's ID.

          Representations
          createSpeedDialContactLink
          Property
          Value
          Comments
          sourceDirectoryID
          String

          Required

          The contact entry's directory ID.
          sourceContactEntryID
          String

          Required

          The contact entry's ID.
          none
          -1
          Identifies that there is no default phone number designated.
          Feature Version
          directories 7
          extension
          0
          Identifies the extension field as the default phone number.
          businessPhone
          1
          Identifies the business phone field as the default phone number.
          businessPhone2
          2
          Identifies the business phone 2 field as the default phone number.
          homePhone
          3
          Identifies the home phone field as the default phone number.
          homePhone2
          4
          Identifies the home phone 2 field as the default phone number.
          mobilePhone
          5
          Identifies the mobile phone field as the default phone number.
          faxPhone
          6
          Identifies the fax phone field as the default phone number.
          pagerPhone
          7
          Identifies the page phone field as the default phone number.
          assistantPhone
          8
          Identifies the assistant phone field as the default phone number.

          Response

          201 - Created
          The contact was successfully linked to the speed dial directory.
          speedDialContactLinkCreated
          Property
          Value
          Comments
          speedDialContactLinkId
          String

          Required

          The created speed dial contact link's ID.
          403 - Forbidden
          The session user does not have permission to create a speed dial contact link.
          error
          Provides additional detail for an error.
          Property
          Value
          Comments
          errorId
          String
          The error identifier that describes the current error.
          message
          String

          Required

          A message that describes the current error.
          503 - Service Unavailable
          The service is currently unavailable.

          Error Responses

          Error Identifier
          Error Type
          Error Description
          error.request.directory.busy
          Type: urn:inin.com:common:error
          The service is not able to acquire lock on contact at this time.
          error
          Provides additional detail for an error.
          Property
          Value
          Comments
          errorId
          String
          The error identifier that describes the current error.
          message
          String

          Required

          A message that describes the current error.
          400 - Bad Request
          The request was invalid. This can occur when the message body is malformed or missing required items. This will also occur if a required header or query string parameter is missing or invalid.
          error
          Provides additional detail for an error.
          Property
          Value
          Comments
          errorId
          String
          The error identifier that describes the current error.
          message
          String

          Required

          A message that describes the current error.
          401 - Unauthorized
          The specified session token is missing, invalid, or has expired.
          Parameters
          Type
          Name
          Comments
          Header
          WWW-Authenticate

          Required

          Indicates that the client needs to authenticate using a custom ICWS scheme, which supports a realm of type ICWS and a location which is the URL at which the client can authenticate. A typical example would be the following.

          WWW-Authenticate: ICWS realm="ICWS" location="/ICWS/connection"

            error
            Provides additional detail for an error.
            Property
            Value
            Comments
            errorId
            String
            The error identifier that describes the current error.
            message
            String

            Required

            A message that describes the current error.
            410 - Gone
            This resource has been deprecated and removed from the API.
            error
            Provides additional detail for an error.
            Property
            Value
            Comments
            errorId
            String
            The error identifier that describes the current error.
            message
            String

            Required

            A message that describes the current error.
            500 - Internal Server Error
            An unexpected error occurred while processing the request.
            error
            Provides additional detail for an error.
            Property
            Value
            Comments
            errorId
            String
            The error identifier that describes the current error.
            message
            String

            Required

            A message that describes the current error.