Messagebird APIs VoiceCalling - Revision history

Pchero: /* The play tag */

2018-10-12T08:19:27Z

The play tag

@@ Line 421: / Line 421: @@
 * endKey : string : If set, determines which DTMF triggers the next step. The end key is not included in the resulting variable. If not set, no key will trigger the next step. : No
 * maxNumKeys : integer : An optional limit to the number of DTMF events that should be gathered before continuing to the next step. By default, this is set to 1, so any key will trigger the next step. If EndKey is set and MaxNumKey is unset, no limit for the number of keys that will be gathered will be imposed. It is possible for less keys to be gathered if the EndKey is pressed or the timeout being reached. : No
 == See also ==

Pchero: /* The play tag */

2018-10-11T15:42:00Z

The play tag

← Older revision		Revision as of 15:42, 11 October 2018
Line 419:		Line 419:
	* url : string : The URL of the media file to play. The media file should be a WAV file(mono, 8kHz, 16bit). : Yes		* url : string : The URL of the media file to play. The media file should be a WAV file(mono, 8kHz, 16bit). : Yes
	* onKeypressVar : string : The name of the variable used for storing a keypress value when a key is pressed during this step. Variables can be used in If conditions. : No		* onKeypressVar : string : The name of the variable used for storing a keypress value when a key is pressed during this step. Variables can be used in If conditions. : No
			* endKey : string : If set, determines which DTMF triggers the next step. The end key is not included in the resulting variable. If not set, no key will trigger the next step. : No
			* maxNumKeys : integer : An optional limit to the number of DTMF events that should be gathered before continuing to the next step. By default, this is set to 1, so any key will trigger the next step. If EndKey is set and MaxNumKey is unset, no limit for the number of keys that will be gathered will be imposed. It is possible for less keys to be gathered if the EndKey is pressed or the timeout being reached. : No

	== See also ==		== See also ==

Pchero: /* The call flow object */

2018-10-11T15:36:29Z

The call flow object

← Older revision		Revision as of 15:36, 11 October 2018
Line 158:		Line 158:
	: steps : array : An array of step objects. The sequence of the array items describe the order of execution, where the first item will be executed first, than the second, etcetera.		: steps : array : An array of step objects. The sequence of the array items describe the order of execution, where the first item will be executed first, than the second, etcetera.
	: steps[].id : string : The unique (within the call flow) identifier of the step.		: steps[].id : string : The unique (within the call flow) identifier of the step.
	: steps[].action : string : The name of the VoIP action. ~~Possible items~~: transfer, say, play, pause, record, fetchCallFlow, hangup.		: steps[].action : string : The name of the VoIP action.
			:: transfer : Transfers the call to a different phone/server.
			:: say : Pronounces a text message with a given voice and language.
			:: play : Plays back an audio file.
			:: pause : Pauses (silently) for a given duration.
			:: record : Initiates an audio recording during a call, e.g. for capturing a user response.
			:: fetchCallFlow : Fetches a call flow from a remote URL.
			:: hangup : Ends the call.
	: steps[].options : object : Contains zero or more key-value pairs, where the key is the identifier of the option and value is the option value. See below for allowed values.		: steps[].options : object : Contains zero or more key-value pairs, where the key is the identifier of the option and value is the option value. See below for allowed values.
	: default : bool : The default attribute says whether the cal flow will be used when no call flow found for inbound number. Only one		: default : bool : The default attribute says whether the cal flow will be used when no call flow found for inbound number. Only one

Pchero: /* The say tag */

2018-10-08T20:58:31Z

The say tag

← Older revision		Revision as of 20:58, 8 October 2018
Line 400:		Line 400:
	* '''attribute''' : '''type''' : '''description''' : '''required'''		* '''attribute''' : '''type''' : '''description''' : '''required'''
	* id : string : The identifier of the step. : No		* id : string : The identifier of the step. : No
	* language : string : The language of the text that is to be pronounced. Required when steps[].action is say. Allowed values: cy-gb,da-dk,de-de,el-gr,en-au,en-gb,en-gb-wls,en-in,en-us,es-es,es-mx,es-us,fr-ca,fr-fr,id-id,is-is,it-it,ja-jp,ko-kr,ms-my,nb-no,nl-nl,pl-pl,pt-br,pt-pt,ro-ro,ru-ru,sv-se,ta-in,th-th,tr-tr,vi-vn,zh-cn,zh-hk. : Yes		* language : string : The language of the text that is to be pronounced. Required when steps[].action is say. Allowed values are cy-gb,da-dk,de-de,el-gr,en-au,en-gb,en-gb-wls,en-in,en-us,es-es,es-mx,es-us,fr-ca,fr-fr,id-id,is-is,it-it,ja-jp,ko-kr,ms-my,nb-no,nl-nl,pl-pl,pt-br,pt-pt,ro-ro,ru-ru,sv-se,ta-in,th-th,tr-tr,vi-vn,zh-cn,zh-hk. : Yes
	* voice : string : The voice to use for pronouncing text. Allowed values: male, female. : Yes		* voice : string : The voice to use for pronouncing text. Allowed values: male, female. : Yes
	* onKeypressVar : string : The name of the variable used for storing a keypress value when a key is pressed during this step. Variables can be used in If conditions. : No		* onKeypressVar : string : The name of the variable used for storing a keypress value when a key is pressed during this step. Variables can be used in If conditions. : No
	* onKeypressGoto : string : The ID of the step to jump to when the caller presses a key during this step. : No		* onKeypressGoto : string : The ID of the step to jump to when the caller presses a key during this step. : No
	* maxNumKeys : integer : An optional limit to the number of DTMF events that should be gathered before continuing to the next step. By default, this is set to 1, so any key will trigger the next step. If EndKey is set and MaxNumKeys is unset, no limit for the number of keys that will be gathered will be imposed. It is possible for less keys to be gathered if the EndKey is pressed or the timeout being reached. : No		* maxNumKeys : integer : An optional limit to the number of DTMF events that should be gathered before continuing to the next step. By default, this is set to 1, so any key will trigger the next step. If EndKey is set and MaxNumKeys is unset, no limit for the number of keys that will be gathered will be imposed. It is possible for less keys to be gathered if the EndKey is pressed or the timeout being reached. : No

			==== The play tag ====
			Plays back an audio file. This is an empty-element tag.
			* '''attribute''' : '''type''' : '''description''' : '''required'''
			* id : string : The identifier of the step. : No
			* url : string : The URL of the media file to play. The media file should be a WAV file(mono, 8kHz, 16bit). : Yes
			* onKeypressVar : string : The name of the variable used for storing a keypress value when a key is pressed during this step. Variables can be used in If conditions. : No

	== See also ==		== See also ==

Pchero: /* Example */

2018-10-08T20:51:23Z

Example

@@ Line 382: / Line 382: @@
+}
 </pre>
 == See also ==

Pchero: /* Creating a call flow */

2018-10-08T20:36:46Z

Creating a call flow

← Older revision		Revision as of 20:36, 8 October 2018
Line 316:		Line 316:

	=== Creating a call flow ===		=== Creating a call flow ===
	==== Required parameters ====		==== Using JSON ====
			===== Required parameters =====
	* '''parameter''' : '''type''' : '''description'''		* '''parameter''' : '''type''' : '''description'''
	* title : string : The title of the new call flow.		* title : string : The title of the new call flow.
	* steps : array : An array of step objects.		* steps : array : An array of step objects.

	==== Optional parameters ====		===== Optional parameters =====
	* '''parameter''' : '''type''' : '''description'''		* '''parameter''' : '''type''' : '''description'''
	* default : bool : The default attribute says whether the call flow will be used when no call flow found for inbound number. Only one default call flow is allowed and the default value for this attributes is false.		* default : bool : The default attribute says whether the call flow will be used when no call flow found for inbound number. Only one default call flow is allowed and the default value for this attributes is false.
	* record : bool : Informs if a full call recording should be performed. If this optoin is set to true, the call will be recorded. The default is false.		* record : bool : Informs if a full call recording should be performed. If this optoin is set to true, the call will be recorded. The default is false.

	==== Returns ====		===== Returns =====
	Returns an object with a data property, which is an array that has a single call flow object if the request was successful. If the request failed, an error object will be returned.		Returns an object with a data property, which is an array that has a single call flow object if the request was successful. If the request failed, an error object will be returned.

	==== Definition ====		===== Definition =====
	<pre>		<pre>
	POST https://voice.messagebird.com/call-flows		POST https://voice.messagebird.com/call-flows
	</pre>		</pre>

	==== Example ====		===== Example =====
	Request		Request
	<pre>		<pre>

Pchero: /* Example */

2018-10-08T20:35:10Z

Example

@@ Line 312: / Line 312: @@
+         }
+     ]
+}
 </pre>

Pchero: /* Example */

2018-10-08T20:28:51Z

Example

← Older revision		Revision as of 20:28, 8 October 2018
Line 227:		Line 227:
	</pre>		</pre>

	* EXAMPLE RESOURCE		Response
	<pre>		<pre>
	{		{

Pchero: /* List all call flows */

2018-10-08T20:28:36Z

List all call flows

← Older revision		Revision as of 20:28, 8 October 2018
Line 211:		Line 211:
	Retrieves a listing of all call flows.		Retrieves a listing of all call flows.

	* RETURNS		==== Returns ====
	Returns an object with a data, _links and paginatioin properties if the request was successful. If the request failed, an error object will be returned.		Returns an object with a data, _links and paginatioin properties if the request was successful. If the request failed, an error object will be returned.

	The data property is an array of call flow objects. The _links property is an object with HATEOAS links related to the object listing. The pagination property is an object with details about the result page count, total count and pagination numbers.		The data property is an array of call flow objects. The _links property is an object with HATEOAS links related to the object listing. The pagination property is an object with details about the result page count, total count and pagination numbers.

	* DEFINITION		==== Definition ====
	<pre>		<pre>
	GET https://voice.messagebird.com/call-flows		GET https://voice.messagebird.com/call-flows
	</pre>		</pre>

	* CURL EXAMPLE REQUEST		==== Example ====
			Request
	<pre>		<pre>
	$ curl -X "GET" "https://voice.messagebird.com/call-flows" \ -H "Authorization: AccessKey test_gshuPaZoeEG6ovbc8M79w0QyM" \ -H "X-MessageBird-Version: 20170314"		$ curl -X "GET" "https://voice.messagebird.com/call-flows" \ -H "Authorization: AccessKey test_gshuPaZoeEG6ovbc8M79w0QyM" \ -H "X-MessageBird-Version: 20170314"
Line 246:		Line 247:
	"id": "f21869b7-b022-4e54-aebd-0deac73c0efc",		"id": "f21869b7-b022-4e54-aebd-0deac73c0efc",
	"options": {		"options": {
	"token": "~~tp0W3PmpH9BYnpMLD3DzQi1su8NjeGPBtIOwAjjkUfg~~=",		"token": "tp0W3PmpH9BYnpMLD3Dz12Qi1su8NjeGPBtIOwAjjkUfg=",
	"url": "https://flows.messagebird.com/svc/voice/call-flow?flowId=976946d6-0c62-4727-b8fc-f57560e8c7e2&invocationId=&nextStepId="		"url": "https://flows.messagebird.com/svc/voice/call-flow?flowId=976946d6-0c62-4727-b8fc-f57560e8c7e2&invocationId=&nextStepId="
	}		}

Pchero: /* Example */

2018-10-08T20:27:50Z

Example

← Older revision		Revision as of 20:27, 8 October 2018
Line 302:		Line 302:
	"id": "f21869b7-b022-4e54-aebd-0deac73c0efc",		"id": "f21869b7-b022-4e54-aebd-0deac73c0efc",
	"options": {		"options": {
	"token": "~~tp0W3PmpH9BYnpMLD3DzQi1su8NjeGPBtIOwAjjkUfg~~=",		"token": "tp0W3PmpH9BYnpMLD3DzQi1su8NjeGPBtIOwAjjkU12fg=",
	"url": "https://flows.messagebird.com/svc/voice/call-flow?flowId=976946d6-0c62-4727-b8fc-f57560e8c7e2&invocationId=&nextStepId="		"url": "https://flows.messagebird.com/svc/voice/call-flow?flowId=976946d6-0c62-4727-b8fc-f57560e8c7e2&invocationId=&nextStepId="
	}		}