Start streaming

This starts the transcription of the audio stream.

Use in conjunction with the stop-streaming endpoint to control when transcription occurs for a given call. This allow you to prevent transcription of sensitive parts of a conversation, such as entering PCI data.

Authorizations

asapp-api-id

string

header

required

asapp-api-secret

string

header

required

Body

application/json

agentId

string

required

The Id of the agent on the call. Usually taken from Call Center CTI information.

customerId

string

required

Id of the customer on the call. Usually taken from Call Center CTI information.

guid

string

required

The globally unique Id for the call, also sometimes called Unique Call Id (UCID). Must be in decimal form.

namespace

enum<string>

required

The media gateway platform or protocol you are using.

Available options:

siprec,

twilio,

amazonconnect,

genesysaudiohook

amazonConnectParams

object

Show child attributes

amazonConnectParams.afterFragmentNumber

string

Amazon fragment number from where you want to start returning the fragments - mandatory if startSelectorType is FRAGMENT_NUMBER

amazonConnectParams.startSelectorType

enum<string>

Identifies the fragment on the Kinesis video stream where you want to start getting the data from

Available options:

NOW,

FRAGMENT_NUMBER

amazonConnectParams.streamArn

string

Amazon stream arn

autotranscribeParams

object

Show child attributes

autotranscribeParams.audioRecordingAllowed

boolean

default:

false

Determines whether ASAPP may record and store the audio for this conversation for the purposes of model training

autotranscribeParams.detailedToken

boolean

default:

false

Determines whether AutoTranscribe outputs word-level details like word content, timestamp and word type

autotranscribeParams.language

string

default:

en-US

IETF language tag

autotranscribeParams.redactionOutput

enum<string>

default:

redacted

Determines whether the transcription output is redacted.

If detailedToken is true, requests with value "redacted" or "redacted_and_unredacted" will be rejected.

If no redaction rules configured by the client for "redacted" or "redacted_and_unredacted", the request will be rejected.

Available options:

redacted,

unredacted,

redacted_and_unredacted

siprecParams

object

Show child attributes

siprecParams.mediaLineOrder

enum<string>

default:

CUSTOMER_FIRST

Defines the mapping of media lines (m-lines) in SDP of SIPREC protocol.

• CUSTOMER_FIRST will map top audio m-line to customer side of conversation (usual for inbound calls to call center, default)
• AGENT_FIRST will map top audio m-line to agent side of the conversation (usual for outbound calls from call center)

Available options:

CUSTOMER_FIRST,

AGENT_FIRST

twilioParams

object

Show child attributes

twilioParams.trackMap

object

Show child attributes

twilioParams.trackMap.inbound

enum<string>

default:

customer

The inbound twilio track

Available options:

customer,

agent

twilioParams.trackMap.outbound

enum<string>

default:

agent

The outbound twilio track

Available options:

customer,

agent

Response

200 - application/json

autotranscribeResponse

object

Show child attributes

autotranscribeResponse.agent

object

Show child attributes

autotranscribeResponse.agent.status

object

Show child attributes

autotranscribeResponse.agent.status.code

integer

autotranscribeResponse.agent.status.description

string

autotranscribeResponse.agent.streamId

string

autotranscribeResponse.customer

object

Show child attributes

autotranscribeResponse.customer.status

object

Show child attributes

autotranscribeResponse.customer.status.code

integer

autotranscribeResponse.customer.status.description

string

autotranscribeResponse.customer.streamId

string

errorMessage

string

isOk

boolean