Restricted Types¶

Some type of data have some restrictions on the allowed values. These types widely used in the APIs are defined here.

First / Last name¶

Here are the character categories allowed:

Alphanumeric: A-Z, a-z, 0-9

Space: ‘ ‘

TODO : complete

CLI (Calling Line Id) First / Last name¶

Here are the character categories allowed:

Alphanumeric: A-Z, a-z, 0-9

Space: ‘ ‘

TODO : complete

Extension¶

Only numerical characters are allowed. Some restrictions on min and max length can apply.

MAC Address¶

INPUT: the format of the input MAC address can be vary. Only integer in range 0-9 and characters in range A-F lower or upper case are allowed. There can be or not separators. Allowed separators ‘-’ or ‘:’.

Eg:

AABBCC001122
AA-BB-CC-00-11-22
AA:BB:CC:00:11:22

OUTPUT: The format of the returned MAC address is with ‘:’ separator.

Eg:

AA:BB:CC:00:11:22

Phone Number¶

INPUT: the format of the input phone numbers can be vary. Only numerical characters are allowed. With the exception on a an optional leading ‘+’, minus ‘-’ or white space ‘ ‘ separators.

Eg:

+32-12345678
0032 12345678
012345678

OUTPUT: The format of the returned phone numbers is E.164. E.164 defines a general format for international telephone numbers. Plan-conforming numbers are limited to a maximum of 15 digits, excluding the international call prefix.

As described in by the ITU, the E.164 general format must contain only digits split as follows:

Country code (max 3 digits)

Subscriber number (max 12 digits)

Eg:

+3212345678

Destination Number¶

The number must be either an extension, a phone number of a feature code (such as a code to redirect to voice mail).

Language¶

See Language.

Template Name¶

It’s the name of the template to use to automatically configure some properties of the end point.

Datetime¶

Datetime format: %Y-%m-%d %H:%M:%S. For instance: 2019-03-18 13:41:13.

Datetime utc¶

Datetime format: %Y-%m-%d %H:%M:%S %z. For instance: 2019-03-18 13:41:13 +0100.

Service Type¶

When The APIO names are used the following values are supported:

“IVR” (only in request, not in answer)
“IVR - Basic”
“IVR - Standard”
“Anywhere Portal”
“Call Center” (only in request, not in answer)
“Call Center - Basic”
“Call Center - Standard”
“Call Center - Premium”
“Find-me/Follow-me”
“Flexible Seating Host”
“Group Paging”
“Hunt Group”
“Instant Group Call”
“Instant Conference Bridge”
“Meet-Me Conference Bridge”
“Route Point”
“VoiceXML”

When The Broadsoft names are used the following values are supported:

“Auto Attendant”
“Auto Attendant - Standard”
“BroadWorks Anywhere Portal”
“Call Center” (only in request, not in answer)
“Call Center - Basic”
“Call Center - Standard”
“Call Center - Premium”
“Find-me/Follow-me”
“Flexible Seating Host”
“Group Paging”
“Hunt Group”
“Instant Group Call”
“Instant Conference Bridge”
“Meet-Me Conference Bridge”
“Route Point”
“VoiceXML”

Language and language code¶

language and language_code are strings.

language_code is a derived parameter of the language. It is usually a read-only parameter meaning that it is present in the GET but will be ignored in POST and PUT except stated explicitly differently. It can be either the short (e.g. “en”) of the long notation (e.g. “en_US”). It is controlled via the following configuration settings:

"USER_LANGUAGES" : ["English", "Flemish", "French"],
"LANGUAGES_CODES": {
    "English" : "en",
    "French": "fr",
    "Flemish": "nl_BE"
},
"DEFAULT_LANGUAGE" : "English"

With following parameters:

USER_LANGUAGES: Is the list of supported languages. It MUST of course be inline with what the Application Server supports.
LANGUAGES_CODES: Is the mapping between a language name and a language code. The codes MUST be unique because in some logics this mapping will be accessed from the codes’ side. Of course it si highly recommended that the 2 settings are inline. If the mapping is not present for a language then no language_code wil be returned.
DEFAULT_LANGUAGE: It is the default language that will be set when none is provided in a POST request.

The values in the example are the default ones.