Describe the call flow from the SVAML payload

Request

This endpoint is useful for understanding the structure and flow of a SVAML payload without executing it. It provides a detailed description of the commands, events, and messages defined in the SVAML.

Security

BasicAuth or SinchOAuth2

Path

projectIdstring, (uuid)(Project ID)required

The ID of the project.

Bodyapplication/json

svamlobject(SVAML Input)required

The SVAML payload to describe.

curl -i -X POST \
  -u '<username>:<password>' \
  'https://voice.api.sinch.com/v2/projects/{projectId}/svaml/describe' \
  -H 'Content-Type: application/json' \
  -d '{
    "svaml": {
      "callName": "incoming",
      "commands": [
        {
          "command": "answer"
        },
        {
          "command": "messages",
          "messages": [
            {
              "type": "SAY",
              "say": {
                "text": "Welcome to ACME support.",
                "voiceName": "Emma"
              }
            }
          ]
        }
      ]
    }
  }'

Responses

SVAML description provided

Bodyapplication/json

descriptionstring

Human-readable description of the call flow.

Response

{
  "description": "The call is answered and a TTS message is played using the voice Emma."
}

We'd love to hear from you!