Table of Contents

API : PBX : Conference Lookup

Introduction

This API is used to validate that one or more numbers are valid and can be added to the access list of a conference.

Extensions and external numbers can be looked up.

Request

This request finds user names by phone numbers

URL https://api.telecomx.dk/pbx/conference/lookup
Method GET, POST
Access level MANAGER or OWNER if user belongs to the customer.
RESELLER if customer belongs to the reseller.
ADMIN.
Body/Query customer Id Id of the customer the conference belongs to.
numbers Array List of numbers to lookup. Extension or external number in E.164 format.

Request body example

{
  customer: '12345678901234567890ABCD',
  numbers: ['200', '+4599780028', '71919002']
}

Response

JSON object
invalid Array List of numbers that are not valid, and cannot be added to a conference access list.
valid Array List of numbers that are valid and can be added to a conference access list.
valid[].number String Phone number or local extension.
valid[].name String Name, if available.

Example

{ 
  valid: [
    {
      number: '+4599780028',
      name: 'Jon Snow'
    }, {
      ...
    }
  ], 
  invalid: [
    '200',
    '210',
    '+4580808080'
  ]
}

Errors

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