API : PBX : Dialplan Number Status

Introduction

This request is used to check if a dialplan number is in use.

URL	https://api.telecomx.dk/pbx/dialplan/numberStatus
Method	GET
Access level	VIEWER, MANAGER or OWNER if user belongs to the customer. RESELLER if customer belongs to the reseller. ADMIN.
Query	customer	Id of customer to check (24 char hex).
Query	number	Number to lookup, 1-7 digits.

https://api.telecomx.dk/pbx/dialplan/numberStatus?customer=12345678901234567890ABCD&number=592

JSON object
exists	Boolean	True if found.
_id	Id	Id of the dialplan item that is using the number.
type	String	Type of item: EXTENSION - a local extension TRUNK - entry point for inbound calls CONFERENCE - a conference room where multiple parties can talk DIAL - dial a destination DISA - callback/dialtone PLAYBACK - play an audio file QUEUE - queue SET_VALUE - sets a value MENU_ROUTER - route based on menu selection TIME_ROUTER - route based on date/time URL_ROUTER - route based on URL call reply VALUE_ROUTER - route based on a value GROUP - a group of extensions that can be controlled and called.
name	String	Item name.
nextAvailableNumber	String	Next available number to choose

{
  _id: '12345678901234567890ABCD',
  type: 'EXTENSION',
  name: 'Donald Duck',
  nextAvailableNumber; '447'
}

JSON object
exists	Boolean	False if not found.

{
  exists: false
}

Error code	Message	Description
400	customer	Customer not found
404	number	Number is invalid, 1-7 digits, # or * required
403	access_denied	Insufficient access level
500	internal_error	<Unspecified>