POST
/
mg-autotranscribe
/
v1
/
start-streaming
Start streaming
curl --request POST \
  --url https://api.sandbox.asapp.com/mg-autotranscribe/v1/start-streaming \
  --header 'Content-Type: application/json' \
  --header 'asapp-api-id: <api-key>' \
  --header 'asapp-api-secret: <api-key>' \
  --data '{
  "namespace": "siprec",
  "guid": "0867617078-0032318833-2221801472-0002236962",
  "customerId": "customerId",
  "agentId": "agentId",
  "autotranscribeParams": {
    "language": "en-US"
  },
  "siprecParams": {
    "mediaLineOrder": "CUSTOMER_FIRST"
  }
}'
{
  "isOk": true,
  "autotranscribeResponse": {
    "customer": {
      "streamId": "5ce2b755-3f38-11ed-b755-7aed4b5c38d5",
      "status": {
        "code": 1000,
        "description": "OK"
      }
    },
    "agent": {
      "streamId": "cf31116-3f38-11ed-9116-7a0a36c763f1",
      "status": {
        "code": 1000,
        "description": "OK"
      }
    }
  }
}

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
Example:
{
  "language": "en-US",
  "detailedToken": false,
  "audioRecordingAllowed": false,
  "redactionOutput": "redacted"
}
​
siprecParams
object
​
twilioParams
object
Example:
{
  "trackMap": {
    "inbound": "customer",
    "outbound": "agent"
  }
}
​
amazonConnectParams
object
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
​
isOk
boolean
​
errorMessage
string