Describe Contact

connect_describe_contact

R Documentation

This API is in preview release for Amazon Connect and is subject to change

Description

This API is in preview release for Amazon Connect and is subject to change.

Describes the specified contact.

• SystemEndpoint is not populated for contacts with initiation method of MONITOR, QUEUE_TRANSFER, or CALLBACK

• Contact information remains available in Amazon Connect for 24 months from the InitiationTimestamp, and then it is deleted. Only contact information that is available in Amazon Connect is returned by this API.

Usage

connect_describe_contact(InstanceId, ContactId)

Arguments

InstanceId	[required] The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
ContactId	[required] The identifier of the contact.

Value

A list with the following syntax:

list(
  Contact = list(
    Arn = "string",
    Id = "string",
    InitialContactId = "string",
    PreviousContactId = "string",
    ContactAssociationId = "string",
    InitiationMethod = "INBOUND"|"OUTBOUND"|"TRANSFER"|"QUEUE_TRANSFER"|"CALLBACK"|"API"|"DISCONNECT"|"MONITOR"|"EXTERNAL_OUTBOUND"|"WEBRTC_API"|"AGENT_REPLY"|"FLOW",
    Name = "string",
    Description = "string",
    Channel = "VOICE"|"CHAT"|"TASK"|"EMAIL",
    QueueInfo = list(
      Id = "string",
      EnqueueTimestamp = as.POSIXct(
        "2015-01-01"
      )
    ),
    AgentInfo = list(
      Id = "string",
      ConnectedToAgentTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      AgentPauseDurationInSeconds = 123,
      HierarchyGroups = list(
        Level1 = list(
          Arn = "string"
        ),
        Level2 = list(
          Arn = "string"
        ),
        Level3 = list(
          Arn = "string"
        ),
        Level4 = list(
          Arn = "string"
        ),
        Level5 = list(
          Arn = "string"
        )
      ),
      DeviceInfo = list(
        PlatformName = "string",
        PlatformVersion = "string",
        OperatingSystem = "string"
      ),
      Capabilities = list(
        Video = "SEND",
        ScreenShare = "SEND"
      ),
      AfterContactWorkDuration = 123,
      AfterContactWorkStartTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      AfterContactWorkEndTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      AgentInitiatedHoldDuration = 123,
      StateTransitions = list(
        list(
          State = "INITIAL"|"CONNECTED"|"DISCONNECTED"|"MISSED",
          StateStartTimestamp = as.POSIXct(
            "2015-01-01"
          ),
          StateEndTimestamp = as.POSIXct(
            "2015-01-01"
          )
        )
      )
    ),
    InitiationTimestamp = as.POSIXct(
      "2015-01-01"
    ),
    DisconnectTimestamp = as.POSIXct(
      "2015-01-01"
    ),
    LastUpdateTimestamp = as.POSIXct(
      "2015-01-01"
    ),
    LastPausedTimestamp = as.POSIXct(
      "2015-01-01"
    ),
    LastResumedTimestamp = as.POSIXct(
      "2015-01-01"
    ),
    TotalPauseCount = 123,
    TotalPauseDurationInSeconds = 123,
    ScheduledTimestamp = as.POSIXct(
      "2015-01-01"
    ),
    RelatedContactId = "string",
    WisdomInfo = list(
      SessionArn = "string"
    ),
    CustomerId = "string",
    CustomerEndpoint = list(
      Type = "TELEPHONE_NUMBER"|"VOIP"|"CONTACT_FLOW"|"CONNECT_PHONENUMBER_ARN"|"EMAIL_ADDRESS",
      Address = "string",
      DisplayName = "string"
    ),
    SystemEndpoint = list(
      Type = "TELEPHONE_NUMBER"|"VOIP"|"CONTACT_FLOW"|"CONNECT_PHONENUMBER_ARN"|"EMAIL_ADDRESS",
      Address = "string",
      DisplayName = "string"
    ),
    QueueTimeAdjustmentSeconds = 123,
    QueuePriority = 123,
    Tags = list(
      "string"
    ),
    ConnectedToSystemTimestamp = as.POSIXct(
      "2015-01-01"
    ),
    RoutingCriteria = list(
      Steps = list(
        list(
          Expiry = list(
            DurationInSeconds = 123,
            ExpiryTimestamp = as.POSIXct(
              "2015-01-01"
            )
          ),
          Expression = list(
            AttributeCondition = list(
              Name = "string",
              Value = "string",
              ProficiencyLevel = 123.0,
              Range = list(
                MinProficiencyLevel = 123.0,
                MaxProficiencyLevel = 123.0
              ),
              MatchCriteria = list(
                AgentsCriteria = list(
                  AgentIds = list(
                    "string"
                  )
                )
              ),
              ComparisonOperator = "string"
            ),
            AndExpression = list(
              list()
            ),
            OrExpression = list(
              list()
            ),
            NotAttributeCondition = list(
              Name = "string",
              Value = "string",
              ProficiencyLevel = 123.0,
              Range = list(
                MinProficiencyLevel = 123.0,
                MaxProficiencyLevel = 123.0
              ),
              MatchCriteria = list(
                AgentsCriteria = list(
                  AgentIds = list(
                    "string"
                  )
                )
              ),
              ComparisonOperator = "string"
            )
          ),
          Status = "ACTIVE"|"INACTIVE"|"JOINED"|"EXPIRED"
        )
      ),
      ActivationTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      Index = 123
    ),
    Customer = list(
      DeviceInfo = list(
        PlatformName = "string",
        PlatformVersion = "string",
        OperatingSystem = "string"
      ),
      Capabilities = list(
        Video = "SEND",
        ScreenShare = "SEND"
      )
    ),
    Campaign = list(
      CampaignId = "string"
    ),
    AnsweringMachineDetectionStatus = "ANSWERED"|"UNDETECTED"|"ERROR"|"HUMAN_ANSWERED"|"SIT_TONE_DETECTED"|"SIT_TONE_BUSY"|"SIT_TONE_INVALID_NUMBER"|"FAX_MACHINE_DETECTED"|"VOICEMAIL_BEEP"|"VOICEMAIL_NO_BEEP"|"AMD_UNRESOLVED"|"AMD_UNANSWERED"|"AMD_ERROR"|"AMD_NOT_APPLICABLE",
    CustomerVoiceActivity = list(
      GreetingStartTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      GreetingEndTimestamp = as.POSIXct(
        "2015-01-01"
      )
    ),
    QualityMetrics = list(
      Agent = list(
        Audio = list(
          QualityScore = 123.0,
          PotentialQualityIssues = list(
            "string"
          )
        )
      ),
      Customer = list(
        Audio = list(
          QualityScore = 123.0,
          PotentialQualityIssues = list(
            "string"
          )
        )
      )
    ),
    DisconnectDetails = list(
      PotentialDisconnectIssue = "string"
    ),
    AdditionalEmailRecipients = list(
      ToList = list(
        list(
          Address = "string",
          DisplayName = "string"
        )
      ),
      CcList = list(
        list(
          Address = "string",
          DisplayName = "string"
        )
      )
    ),
    SegmentAttributes = list(
      list(
        ValueString = "string",
        ValueMap = list(
          list()
        ),
        ValueInteger = 123
      )
    ),
    Recordings = list(
      list(
        StorageType = "S3"|"KINESIS_VIDEO_STREAM"|"KINESIS_STREAM"|"KINESIS_FIREHOSE",
        Location = "string",
        MediaStreamType = "AUDIO"|"VIDEO",
        ParticipantType = "ALL"|"MANAGER"|"AGENT"|"CUSTOMER"|"THIRDPARTY",
        FragmentStartNumber = "string",
        FragmentStopNumber = "string",
        StartTimestamp = as.POSIXct(
          "2015-01-01"
        ),
        StopTimestamp = as.POSIXct(
          "2015-01-01"
        ),
        Status = "AVAILABLE"|"DELETED",
        DeletionReason = "string"
      )
    ),
    DisconnectReason = "string",
    ContactEvaluations = list(
      list(
        FormId = "string",
        EvaluationArn = "string",
        Status = "COMPLETE"|"IN_PROGRESS"|"DELETED",
        StartTimestamp = as.POSIXct(
          "2015-01-01"
        ),
        EndTimestamp = as.POSIXct(
          "2015-01-01"
        ),
        DeleteTimestamp = as.POSIXct(
          "2015-01-01"
        ),
        ExportLocation = "string"
      )
    ),
    ContactDetails = list(
      Name = "string",
      Description = "string"
    ),
    Attributes = list(
      "string"
    )
  )
)

Request syntax

svc$describe_contact(
  InstanceId = "string",
  ContactId = "string"
)