API : PBX : Audio record

Introduction

This request will initiate live recording of an audio item. When initiated, the specified extension is called so that the callee may speak the prompt to record.

A client app/website should listen to PBX event AUDIO_RECORD announcements on the realtime interface to monitor the progress of the recording. See realtime.

Request

URL	https://api.telecomx.dk/pbx/audio/record
Method	POST
Access level	MANAGER or OWNER if user belongs to the customer that owns the sound. RESELLER if customer belongs to the reseller. ADMIN.
Body	extension	Id	`[optional]` Id of the extension to call and record through. Can be on any customer, defaults to the users own primary extension.
	customer	Id	`[optional]` Id of customer the audio belongs to, defaults to the users own customer.
	name	String	`[optional]` Name of the audio.
	employee	Id	`[optional]` Id of employee the audio belongs to and can only be used/seen by.

Request body example

{
  extension: '1234567890124567890AAAA',
  customer: '1234567890ABCD1234567890',
  name: 'Welcome to support, please hold',
  employee: null
}

Response

Json object
success	Boolean	True on success.
reference	String	Reference id string, that is used in the AUDIO_RECORD events to identify event that relates to this request.

Example

{
  succes: true,
  reference: '12345678901234567890AAAA'
}

Errors

Error code	Message	Description
404	customer	Customer not found
404	extension	Extension not found
403	access_denied	Insufficient access level
500	internal_error	<Unspecified>

WIKI

Table of Contents