Skip to content

Describe Speaker

voiceid_describe_speaker R Documentation

Describes the specified speaker

Description

Describes the specified speaker.

Usage

voiceid_describe_speaker(DomainId, SpeakerId)

Arguments

DomainId

[required] The identifier of the domain that contains the speaker.
SpeakerId

[required] The identifier of the speaker you are describing.

Value

A list with the following syntax:

list(
  Speaker = list(
    CreatedAt = as.POSIXct(
      "2015-01-01"
    ),
    CustomerSpeakerId = "string",
    DomainId = "string",
    GeneratedSpeakerId = "string",
    LastAccessedAt = as.POSIXct(
      "2015-01-01"
    ),
    Status = "ENROLLED"|"EXPIRED"|"OPTED_OUT"|"PENDING",
    UpdatedAt = as.POSIXct(
      "2015-01-01"
    )
  )
)

Request syntax

svc$describe_speaker(
  DomainId = "string",
  SpeakerId = "string"
)