NCCO reference

A Nexmo Call Control Object (NCCO) is a JSON array that you use to control the flow of a Voice API call. For your NCCO to execute correctly, the JSON objects must be valid.

The order of actions in the NCCO controls the flow of the Call. Actions that have to complete before the next action can be executed are synchronous. Other actions are asynchronous. That is, they are supposed to continue over the following actions until a condition is met. For example, a record action terminates when the endOnSilence option is met. When all the actions in the NCCO are complete, the Call ends.

The NCCO actions and the options and types for each action are:

Action Description Synchronous
record All or part of a Call No
conversation A standard or hosted conference. Yes
connect To a connectable endpoint such as a phone number. Yes
talk Send synthesized speech to a Conversation. Yes, unless bargeIn=true
stream Send audio files to a Conversation. Yes, unless bargeIn=true
input Collect digits from the person you are calling. Yes

All the actions can return the following error codes.

Note: Controlling a Call with Nexmo Call Control Objects explains how to provide your NCCOs to Nexmo after you initiate a Call or Conference.

Record

Use the record action to record a Call or part of a Call:

[
  {
    "action": "record",
    "eventUrl": ["https://example.com/recordings"],
    "endOnSilence": "3"
  },
  {
    "action": "connect",
    "eventUrl": ["https://example.com/events"],
    "from":"441632960960",
    "endpoint": [
      {
        "type": "phone",
        "number": "441632960961"
      }
    ]
  }
]

The record action is asynchronous. Recording starts when the record action is executed in the NCCO and finishes when the synchronous condition in the action is met. That is, endOnSilence, timeOut or endOnKey. If you do not set a synchronous condition, the Voice API immediately executes the next NCCO without recording.

For information about the workflow to follow, see Recordings.
You use the following options to control a record action:

Option Description Required
format Record the Call in a specific format. Options are:
  • mp3
  • wav
The default value is mp3.
No
endOnSilence Stop recording after n seconds of silence. Once the recording is stopped the recording data is sent to event_url. The range of possible values is 3<=endOnSilence<=10. No
endOnKey Stop recording when a digit is pressed on the handset. Possible values are:
  • Digit 0 - 9
  • *
  • #
No
timeOut The maximum length of a recording in seconds. One the recording is stopped the recording data is sent to event_url. The range of possible values is 3<=timeOut<=7200 No
beepStart Set to true to play a beep when a recording starts No
eventUrl The URL to the webhook endpoint that is called asynchronously when a recording is finished. If the message recording is hosted by Nexmo, this webhook contains the URL you need to download the recording and other meta data. No
eventMethod The HTTP method used to make the request to eventUrl. The default value is POST. No


The following example shows the return parameters sent to eventUrl:

{
  "start_time": "2016-09-14T13:21:55Z",
  "recording_url": "https://api.nexmo.com/media/download?id=5345cf0-345c-34b3-a23b-ca6ccfe144b0",
  "size": 84413,
  "recording_uuid": "53383284-b36d-498c-b733-aa0234c2234",
  "end_time": "2016-09-14T13:22:17Z",
  "conversation_uuid": "aa5c81cb-78ef-4e28-234-801c0ea234"
}

Possible return parameters are:

Name Description
recording_uuid The unique ID for the Call.
Note: recording_uuid is not the same as the file uuid in recording_url.
recording_url The URL to the file containing the Call recording. To download a recording, see Record calls and conversations.
start_time The time the recording started in the following format: YYYY-MM-DD HH:MM:SS. For example 2015-02-04 22:45:00
end_time The time the recording finished in the following format: YYYY-MM-DD HH:MM:SS. For example 2015-02-04 23:30:00
size The size of the recording at recording_url in bytes. For example: 603423
conversation_uuid The unique ID for this Call.

Conversation

You use the conversation NCCO to create standard or moderated Conversations. The first person to call the virtual number assigned to the Conversation creates it. This action is synchronous, the Conversation lasts until the number of participants is 0.

Note: you can invite up to 50 people to your Conversation.

The following NCCO examples show how to configure different types of Conversation. You use the answer_url webhook GET request parameters to ensure you deliver one NCCO to participants and another to the moderator.

[
  {
    "action": "conversation",
    "name": "nexmo-conference-standard",
    "record": "true"
  }
]
[
  {
    "action": "talk",
    "text": "Welcome to a Nexmo moderated conference",
    "voiceName": "Amy"
  },
  {
    "action": "conversation",
    "name": "nexmo-conference-moderated",
    "startOnEnter": "false",
    "musicOnHoldUrl": ["https://nexmo-community.github.io/ncco-examples/assets/voice_api_audio_streaming.mp3"]
  }
]
[
  {
  "action": "conversation",
  "name": "nexmo-conference-moderated",
  "endOnExit": "true",
  "record": "true"
 }
]

You use the following options to control a conversation action:

Option Description Required
name The name of the Conversation room. Names have to be unique per account. Yes
musicOnHoldUrl A URL to the mp3 file to stream to participants until the conversation starts. By default the conversation starts when the first person calls the virtual number associated with your Voice app. To stream this mp3 before the moderator joins the conversation, set startOnEnter to false for all users other than the moderator. No
startOnEnter The default value of true ensures that the conversation starts when this caller joins conversation name. Set to false for attendees in a moderated conversation. No
endOnExit For moderated conversations, set to true in the moderator NCCO so the conversation is ended when the moderator hangs up. The default value of false means the conversation is not terminated when a caller hangs up; the conversation ends when the last caller hangs up. No
record Set to true to record this conversation. For standard conversations, recordings start when one or more attendees connects to the conversation. For moderated conversations, recordings start when the moderator joins. That is, when an NCCO is executed for the named conversation where startOnEnter is set to true. When the recording is terminated, the URL you download the recording from is sent to the event URL.
By default audio is recorded in MP3 format. See Recording calls and conversations.
No
eventUrl Set the URL to the webhook endpoint Nexmo calls asynchronously on each of the call states. No
eventMethod Set the HTTP method used to make the request to eventUrl. The default value is POST. No

Connect

Connect to endpoints such as phone numbers.

This action is synchronous, after a connect the next action in the NCCO stack is processed. A connect action ends when the endpoint you are calling is busy or unavailable. You ring endpoints sequentially by nesting connect actions.

You use the following options to control a connect action:

Option Description Required
endpoint Connect to a single endpoint. Possible types are:
  • phone - phone numbers in e.164 format. Options are:
    • number - the phone number to connect to in E.164 format.
    • dtmfAnswer - Set the digits that are sent to the user as soon as the Call is answered. The * and # digits are respected. You create pauses using p. Each pause is 500ms.
  • websocket - the websocket to connect to. Options are:
    • uri - the URI to the websocket you are streaming to.
    • content-type - the internet media type for the audio you are streaming. Possible values are: audio/l16;rate=16000
    • headers - a JSON object containing any metadata you want.
  • sip - the sip endpoint to connect to. Options are:
Yes
from A number in e.164 format that identifies the caller. No
eventType Set to synchronous to:
  • make the connect action synchronous
  • enable eventUrl to return an NCCO that overrides the current NCCO when a call moves to specific states. See the Connect with fallback NCCO example.
No
timeout If the call is unanswered, set the number in seconds before Nexmo stops ringing endpoint. The default value is 60. No
limit Maximum length of the call in seconds. The default and maximum value is 7200s. No
machineDetection Configure the behavior when Nexmo detects that a destination is an answerphone. Set to either:
  • continue - Nexmo sends an HTTP request to event_url with the Call event machine
  • hangup - end the Call
No
eventUrl Set the webhook endpoint that Nexmo calls asynchronously on each of the possible Call states. If eventType is set to synchronous the eventUrl can return an NCCO that overrides the current NCCO when a timeout occurs. Yes
eventMethod The HTTP method Nexmo uses to make the request to eventUrl. The default value is POST. No

Examples

The following NCCO examples show how to configure different types of connection:

Connect to a PSTN endpoint

[
  {
    "action": "talk",
    "text": "Please wait while we connect you"
  },
  {
    "action": "connect",
    "eventUrl": ["https://example.com/events"],
    "timeout": "45",
    "from": "441632960960",
    "endpoint": [
      {
        "type": "phone",
        "number": "441632960961",
        "dtmfAnswer": "2p02p"
      }
    ]
  }
]

Connect to a WebSocket endpoint

[
      {
        "action": "talk",
        "text": "Please wait while we connect you"
      },
      {
        "action": "connect",
        "eventUrl": [
          "https://example.com/events"
        ],
        "from": "441632960960",
        "endpoint": [
        {
          "type": "websocket",
          "uri": "ws://example.com/socket",
          "content-type": "audio/l16;rate=16000",
          "headers": {
            "whatever": "metadata_you_want"
            }
          }
        ]}
]

Connect with fallback NCCO

You can provide a fallback for Calls that do not connect. To do this set the eventType to synchronous and return an NCCO from the eventUrl if the Call enters any of the following states:

  • timeout - your user did not answer your call with ringing_timer seconds
  • failed - the call failed to complete
  • rejected - the call was rejected
  • unanswered - the call was not answered
  • busy - the person being called was on another call
[
  {
    "action": "connect",
    "from": "441632960960",
    "timeout": 5,
    "eventType": "synchronous",
    "eventUrl": [
      "https://example.com/event-fallback"
    ],
    "endpoint": [
      {
        "type": "phone",
        "number": "441632960961"
      }
    ]
  }
]

Connect to a SIP endpoint

[
  {
    "action": "talk",
    "text": "Please wait while we connect you"
  },
  {
    "action": "connect",
    "eventUrl": [
      "https://example.com/events"
    ],
    "from": "441632960960",
    "endpoint": [
      {
        "type": "sip",
        "uri": "sip:rebekka@sip.mcrussell.com"
      }
    ]
  }
]

Recorded proxy call

[
  {
    "action": "record",
    "eventUrl": ["https://example.com/recordings"]
  },
  {
    "action": "connect",
    "eventUrl": ["https://example.com/events"],
    "from": "441632960960",
    "endpoint": [
      {
        "type": "phone",
        "number": "441632960961"
      }
    ]
  }
]

Talk

Send synthesized speech to a Conversation.

By default, the talk action is synchronous. However, if you set bargeIn to true you must set an input action later in the NCCO stack.
The following NCCO examples shows how to send a synthesized speech message to a Conversation or Call:

[
  {
    "action": "talk",
    "text": "You are listening to a Call made with Voice API"
  }
]
[
  {
    "action": "talk",
    "text": "Welcome to a Voice API I V R. ",
    "voiceName": "Amy",
    "bargeIn": false
  },
  {
    "action": "talk",
    "text": "Press 1 for maybe and 2 for not sure followed by the hash key",
    "voiceName": "Amy",
    "bargeIn": true
  },
  {
    "action": "input",
    "submitOnHash": "true",
    "eventUrl": ["https://example.com/ivr"]
  }
]

You use the following options to control a talk action:

Option Description Required
text A string of up to 1500 characters containing the message to be synthesized in the Call or Conversation. Each comma in text adds a short pause to the synthesized speech. Yes
bargeIn Set to true so this action is terminated when the user presses a button on the keypad. Use this feature to enable users to choose an option without having to listen to the whole message in your Interactive Voice Response (IVR ). If you set bargeIn to true the next action in the NCCO stack must be an input action. The default value is false. No
loop The number of times text is repeated before the Call is closed. The default value is 1. Set to 0 to loop infinitely. No
voiceName The name of the voice used to deliver text. You use the voiceName that has the correct language, gender and accent for the message you are sending. For example, the default voice kimberly is a female who speaks English with an American accent (en-US). Possible values for voiceName are:
  • Salli - en-US female
  • Joey - en-US male
  • Naja - da-DK female
  • Mads - da-DK male
  • Marlene - de-DE female
  • Hans - de-DE male
  • Nicole - en-AU female
  • Russell - en-AU male
  • Amy - en-GB female
  • Brian - en-GB male
  • Emma - en-GB female
  • Gwyneth - en-GB-WLS female
  • Geraint - en-GB-WLS male
  • Gwyneth - cy-GB-WLS female
  • Geraint - cy-GB-WLS male
  • Raveena - en-IN female
  • Chipmunk - en-US male
  • Eric - en-US male
  • Ivy - en-US female
  • Jennifer - en-US female
  • Justin - en-US male
  • Kendra - en-US female
  • Kimberly - en-US female
  • Conchita - es-ES female
  • Enrique - es-ES male
  • Penelope - es-US female
  • Miguel - es-US male
  • Chantal - fr-CA female
  • Celine - fr-FR female
  • Mathieu - fr-FR male
  • Dora - is-IS female
  • Karl - is-IS male
  • Carla - it-IT female
  • Giorgio - it-IT male
  • Liv - nb-NO female
  • Lotte - nl-NL female
  • Ruben - nl-NL male
  • Agnieszka - pl-PL female
  • Jacek - pl-PL male
  • Ewa - pl-PL female
  • Jan - pl-PL male
  • Maja - pl-PL female
  • Vitoria - pt-BR female
  • Ricardo - pt-BR male
  • Cristiano - pt-PT male
  • Ines - pt-PT female
  • Carmen - ro-RO female
  • Maxim - ru-RU male
  • Tatyana - ru-RU female
  • Astrid - sv-SE female
  • Filiz - tr-TR female
No

Stream

Send an audio stream to a Conversation

By default, the talk action is synchronous. However, if you set bargeIn to true you must set an input action later in the NCCO stack.

The following NCCO example shows how to send an audio stream to a Conversation or Call:

[
  {
    "action": "stream",
    "streamUrl": ["https://acme.com/streams/music.mp3"]
  }
]
[
  {
    "action": "stream",
    "streamUrl": ["https://acme.com/streams/announcement.mp3"]
    bargeIn: "true"
  },
  {
    "action": "input",
    "submitOnHash": "true",
    "eventUrl": ["https://example.com/ivr"]
  }
]

You use the following options to control a stream action:

Option Description Required
streamUrl An array containing a single URL to an mp3 or wav (16-bit) audio file to stream to the Call or Conversation. Yes
level Set the audio level of the stream in the range -1 >=level<=1 with a precision of 0.1. The default value is 0. No
bargeIn Set to true so this action is terminated when the user presses a button on the keypad. Use this feature to enable users to choose an option without having to listen to the whole message in your Interactive Voice Response (IVR ). If you set bargeIn to true the next action in the NCCO stack must be an input action. The default value is false. No
loop The number of times text is repeated before the Call is closed. The default value is 1. Set to 0 to loop infinitely. No

Input

You use the input action to collect digits input by the person you are calling. This action is synchronous, Nexmo processes the input and forwards it in the parameters sent to the eventURL webhook endpoint you configure in your request. Your webhook endpoint should return another NCCO that replaces the existing NCCO and controls the Call based on the user input. You use this functionality to create an Interactive Voice Response (IVR). For example, if your user presses 4, you return a connect NCCO that forwards the call to your sales department.

The following NCCO example shows how to configure an IVR endpoint:

[
  {
    "action": "talk",
    "text": "Please enter a digit"
  },
  {
    "action": "input",
    "eventUrl": ["https://example.com/ivr"]
  }
]

The following NCCO example shows how to use bargeIn to allow a user to interrupt a talk action. Note that an input action must follow any action that has a bargeIn property (e.g. talk or stream).

[
  {
    "action": "talk",
    "text": "Please enter a digit",
    "bargeIn": true
  },
  {
    "action": "input",
    "eventUrl": ["https://example.com/ivr"]
  }
]

You use the following options to control an input action:

Option Description Required
timeOut The result of the callee's activity is sent to the eventUrl webhook endpoint timeOut seconds after the last action. The default value is 3. No
maxDigits The number of digits the user can press. The maximum value is 20. The default value is 4 No
submitOnHash Set to true so the callee's activity is sent to your webhook endpoint at eventUrl after he or she presses #. If # is not pressed the result is submitted after timeOut seconds. The default value is false. That is, the result is sent to your webhook endpoint after timeOut seconds. No
eventUrl Nexmo sends the digits pressed by the callee to this URL after timeOut pause in activity or when # is pressed. No
eventMethod The HTTP method used to send event information to event_url The default value is POST. No

The following example shows the parameters sent to eventUrl:

{
    "uuid": "56f61045-5b78-2f5h-56h8-46zdgre9264",
    "conversation_uuid": "63f61863-4a51-4f6b-86e1-46edebcf9929",
    "timed_out": true,
    "dtmf": "3109"
}


Possible input webhook parameters send to the eventUrl are:

Name Description
uuid The unique ID of the Call leg for the user initiating the input.
conversation_uuid The unique ID for this conversation.
timed_out Returns true if this input timed out based on the value of timeOut.
dtmf The numbers input by your callee, in order.

Errors

The following HTTP codes are supported:

  • 200 – Success
  • 201 – Resource created
  • 204 – No content
  • 401 – Unauthorised
  • 404 – Not found
  • 429 – Rate limited
  • 500 – Nexmo server error

The error format is standardised to the 4xx/5xx range with a code and a human readable explanation. For example, for an authentication failure.

  {
    "type": "TYPE",
    "error_title":"TITLE",
    "invalid_parameters":{
      "type":"Is required."
    }
  }
Previous   Next