API : PBX : Redirector Status

Introduction

A SIP phone that boots for the first time, or after a factory reset, asks its makers redirection service (zero-touch provisioning) where to fetch its configuration. This request asks the redirection service whether the SIP phones MAC address is registered there, in the Telecom X account.

Currently Yealink (RPS), Snom (SRAPS), Mitel (RCS) and Grandstream (GDMS) are supported - by the brand of the SIP phone model.

To register a SIP phone that is not registered, use Redirector Register.

Notes:

A SIP phone without a MAC address is answered NOT_REGISTERED, whatever its brand.
GDMS has no lookup by MAC address, so checking a Grandstream device adds it to the Telecom X organisation if it is not in another organisation. A Grandstream device without a serial number is not checked; it is reported as NOT_REGISTERED.
A service that cannot be asked is answered with status ERROR (200). Before version 2.30.0 a failed lookup was answered with 422 mac, a 500 or registered: false, depending on the brand.

Request

URL	https://api.telecomx.dk/pbx/sipphone/SIPPHONE_ID/redirectorstatus
Method	GET
Access level	MANAGER, OWNER if user belongs to the customer. RESELLER if customer belongs to the reseller. ADMIN.
Param	SIPPHONE_ID	Id of the SIP phone (24 hex-char string)

Request example

https://api.telecomx.dk/pbx/sipphone/12345678901234567890ABCD/redirectorstatus

Response

The response will be the current redirector status.

Json object
_id	Id	Unique id of the SIP phone.
registered	Boolean	True if registered at the redirection service. Same as status REGISTERED.
status	String	REGISTERED - Registered in the Telecom X account (for Mitel: also sent to the right server). NOT_REGISTERED - Not registered, the SIP phone has no MAC address, registered by another Grandstream organisation, or a Mitel phone sent to the wrong one of our servers (e.g. a 67xx sent to server TCX instead of TCXHTTP). REGISTERED_BY_OTHER - The service says another company has registered the MAC address (only Yealink RPS tells this). ERROR - The service could not be asked - timeout, authentication or an unexpected answer.
error	String	`[optional]` Why the status is not REGISTERED, when that is known. The text is in English: either our own explanation, or the service's answer prefixed by what failed (Check failed: , Login failed: ).

Example

{
  _id: '12345678901234567890ABCD',
  registered: false,
  status: 'ERROR',
  error: 'timeout of 5000ms exceeded'
}

Errors

Error code	Message	Description
403	access_denied	Insufficient access level
404	not_found	SIP phone not found
404	sipPhoneModel	SIP phone model not found
422	id	Invalid ObjectId
422	id	Device not supported - the brand of the SIP phone model has no redirection service
500	internal_error	<Unspecified>

WIKI

Table of Contents