Start streaming - ASAPP Docs

Authorizations

asapp-api-id

string

header

required

asapp-api-secret

string

header

required

Body

application/json

namespace

enum<string>

required

The media gateway platform or protocol you are using.

Available options:

siprec,

twilio,

amazonconnect,

genesysaudiohook

guid

string

required

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

customerId

string

required

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

agentId

string

required

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

autotranscribeParams

object

Show child attributes

autotranscribeParams.language

string

default:en-US

IETF language tag

autotranscribeParams.detailedToken

boolean

default:false

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

autotranscribeParams.audioRecordingAllowed

boolean

default:false

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

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

Example:

{
  "language": "en-US",
  "detailedToken": false,
  "audioRecordingAllowed": false,
  "redactionOutput": "redacted"
}

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

Example:

{
  "trackMap": {
    "inbound": "customer",
    "outbound": "agent"
  }
}

amazonConnectParams

object

Show child attributes

amazonConnectParams.streamArn

string

Amazon stream arn

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.afterFragmentNumber

string

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

Example:

{
  "streamArn": "arn:aws:kinesisvideo:us-east-1:000000000000:stream/streamtest-connect-asappconnect-contact-1117e864-690f-4e1e-9dcf-6fbfcc288e41/1654194145007",
  "startSelectorType": "FRAGMENT_NUMBER",
  "afterFragmentNumber": "91343852333181476958523476930058290730435475343"
}

Response

Router processed the request, details are in the response body

autotranscribeResponse

object

Show child attributes

autotranscribeResponse.customer

object

Show child attributes

autotranscribeResponse.customer.streamId

string

Example:

"5ce2b755-3f38-11ed-b755-7aed4b5c38d5"

autotranscribeResponse.customer.status

object

Show child attributes

autotranscribeResponse.customer.status.code

integer

Example:

1000

autotranscribeResponse.customer.status.description

string

Example:

"OK"

autotranscribeResponse.agent

object

Show child attributes

autotranscribeResponse.agent.streamId

string

Example:

"5ce2b755-3f38-11ed-b755-7aed4b5c38d5"

autotranscribeResponse.agent.status

object

Show child attributes

autotranscribeResponse.agent.status.code

integer

Example:

1000

autotranscribeResponse.agent.status.description

string

Example:

"OK"

isOk

boolean

errorMessage

string

ASAPP APIs

Authorizations

Body

Response